Generate Upload Signature

Beta

POST

https://api.bigcommerce.com/stores/:store_hash/v3/infrastructure/deployments/uploads

POST

/stores/:store_hash/v3/infrastructure/deployments/uploads

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/infrastructure/deployments/uploads \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Generate an upload signature

{
  "data": {
    "upload_url": "https://storage.googleapis.com/bigcommerce-production-ignition-gcs-bucket-platform/0000000000/0194fd2b-2ac6-72de-b73f-d83f2d626a74/bundle.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=example%40bigcommerce-production.iam.gserviceaccount.com%2F20240615%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20240615T103000Z&X-Goog-Expires=59&X-Goog-Signature=example-signature&X-Goog-SignedHeaders=content-type%3Bhost",
    "upload_uuid": "0194fd2b-2ac6-72de-b73f-d83f2d626a74"
  },
  "meta": {}
}

Generates a pre-signed upload URL for uploading deployment artifacts. Use the returned upload_url to upload your deployment package, then pass the upload_uuid when creating a deployment.

Send an empty JSON object ({}) as the request body. Omitting the body returns a 400 Bad Request 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.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

Response

The upload signature was generated successfully.

dataobjectOptional

metaobjectOptional

Empty meta object.