Promote a deployment
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/hosting/deployments/example/promote';const options = {method: 'POST', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://apibase.ecomweb.app/api/v1/stores/example/hosting/deployments/example/promote \ --header 'x-api-key: <x-api-key>'Makes the store’s storefront serve this deployment, and publishes the deployment’s theme with this build as its version in use. Promoting an earlier deployment is how you roll back. It answers 202 while the rollout starts; the previous deployment keeps serving until the new one is ready. Only a deployment that has finished building can be promoted. Needs a plan that includes Hosting.
Required scopes: deploy:storefront
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The deployment ID.
The store’s ref, as returned by GET /stores.
Responses
Section titled “Responses”object
The deployment the store’s storefront serves, or null when the shared storefront does.
none: the shared storefront serves the store. rolling_out: a deployment is being put
live and the previous one keeps serving. running: it is serving. degraded: it has a
problem.
Why the last rollout failed, or null. The store keeps serving what it served before.
The addresses the storefront answers on.
Example
{ "state": "none"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The request conflicts with the resource’s current state.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}