Trigger a deployment

Triggers a new deployment from the configured auto-deploy branch.

Triggers a new deployment from the currently configured auto-deploy branch.

Requires the storefront:deployments:write or storefront.write permission.

Request

POST /storefront/deployments/github/deploy

Headers

HeaderValue
AuthorizationBearer <token>

Response

Returns HTTP 200 with {"ok": true} on success. Returns HTTP 429 Too Many Requests if a deployment was already triggered recently.

Example Response

{
  "ok": true
}
Responses

429

Too Many Requests — deployment already in progress

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json