Create a Deployment | BigCommerce Developer Center

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 Name	Permission	Parameter
Infrastructure Deployments	read-only	`store_infrastructure_deployments_read_only`
Infrastructure Deployments	create preview	`store_infrastructure_deployments_create_preview`
Infrastructure Deployments	manage	`store_infrastructure_deployments_manage`
Infrastructure Projects	read-only	`store_infrastructure_projects_read_only`
Infrastructure Projects	manage	`store_infrastructure_projects_manage`
Infrastructure Logs	read-only	`store_infrastructure_logs_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Infrastructure Deployments | read-only | `store_infrastructure_deployments_read_only` | | Infrastructure Deployments | create preview | `store_infrastructure_deployments_create_preview` | | Infrastructure Deployments | manage | `store_infrastructure_deployments_manage` | | Infrastructure Projects | read-only | `store_infrastructure_projects_read_only` | | Infrastructure Projects | manage | `store_infrastructure_projects_manage` | | Infrastructure Logs | read-only | `store_infrastructure_logs_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

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.

dataobject

metaobject

Empty meta object.

Errors

409

Conflict Error

OAuth scopes

UI Name	Permission	Parameter
Infrastructure Deployments	read-only	`store_infrastructure_deployments_read_only`
Infrastructure Deployments	create preview	`store_infrastructure_deployments_create_preview`
Infrastructure Deployments	manage	`store_infrastructure_deployments_manage`
Infrastructure Projects	read-only	`store_infrastructure_projects_read_only`
Infrastructure Projects	manage	`store_infrastructure_projects_manage`
Infrastructure Logs	read-only	`store_infrastructure_logs_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/infrastructure/deployments"
4
5	payload = {
6	"upload_uuid": "0194fd2b-2ac6-72de-b73f-d83f2d626a74",
7	"project_uuid": "01956ca2-72dd-7968-9484-469ce291d38f",
8	"environment_variables": [
9	{
10	"type": "plain_text",
11	"key": "API_URL",
12	"value": "https://api.example.com"
13	},
14	{
15	"type": "secret",
16	"key": "API_SECRET",
17	"value": "s3cret"
18	}
19	]
20	}
21	headers = {
22	"X-Auth-Token": "<apiKey>",
23	"Content-Type": "application/json"
24	}
25
26	response = requests.post(url, json=payload, headers=headers)
27
28	print(response.json())

1	{
2	"data": {
3	"deployment_uuid": "019500e2-933d-7057-8e81-090dd7240795"
4	},
5	"meta": {}
6	}