Skip to navigation
RESTAdminManagementInfrastructure HostingDeployments

Create a Deployment

Beta

Creates a new deployment for an infrastructure hosting project. You must first generate an upload signature and upload your deployment artifact before creating a deployment.

Only one deployment can be in progress per project at a time. If a deployment is already in progress, the API returns a 409 Conflict response.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Infrastructure Deploymentsread-onlystore_infrastructure_deployments_read_only
Infrastructure Deploymentscreate previewstore_infrastructure_deployments_create_preview
Infrastructure Deploymentsmanagestore_infrastructure_deployments_manage
Infrastructure Projectsread-onlystore_infrastructure_projects_read_only
Infrastructure Projectsmanagestore_infrastructure_projects_manage
Infrastructure Logsread-onlystore_infrastructure_logs_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.
upload_uuidstringRequired
The UUID of the uploaded deployment artifact, obtained from the Generate Upload Signature endpoint.
project_uuidstringRequiredformat: "uuid"
The UUID of the project to deploy to.
environment_variableslist of objects or nullOptional
Optional environment variables to set for this deployment.

Response

The deployment was created successfully.
dataobjectOptional
metaobjectOptional
Empty meta object.

Errors

409
Conflict Error