Launch API | File Upload

Get a Signed Upload URL for a Project

GEThttps://launch-api.contentstack.com/projects/upload/signed_url

The Get a Signed Upload URL for a Project request fetches the details of the signed URL where you must upload the file while creating a project.

As the next step, Upload Your Deployment Zip File to the Signed URL.

Hide Parameters

Headers

authorizationoptionalstring

Use a bearer token to authenticate if you're not using the authtoken header. Format: Bearer . If provided, the organization_uid header isn't required.

authtokenoptionalstring

Use an authentication token if the Authorization header isn't provided. **Requires the organization_uid header.** When using authtoken authentication, you must explicitly provide the organization_uid header. The organization_uid cannot be derived from project_uid for Launch REST APIs.

x-cs-api-versionoptionalstring

Enter the API version. Default is 1.0

organization_uidoptionalstring

⚠️ **REQUIRED when using authtoken authentication** - you must explicitly provide this header. Optional with Authorization Bearer token (organization_uid can be derived from the token).

Sample Response

Status|200 OK

{
  "uploadUrl": "https://test-upload-url.com",
  "expiresIn": 900,
  "uploadUid": "50xxxxa8",
  "method": "POST",
  "fields": [
    {
      "formFieldKey": "bucket",
      "formFieldValue": "

Get a Signed Upload URL for an Environment

GEThttps://launch-api.contentstack.com/projects/{project_uid}/environments/upload/signed_url

The Get a Signed Upload URL for an Environment request fetches the details of the signed URL where you must upload the file when creating an environment.

As the next step, Upload Your Deployment Zip File to the Signed URL.

Hide Parameters

URL Parameters

project_uidrequiredstring

Enter the project_uid of the FILEUPLOAD project where the environments belong.

Headers

authorizationoptionalstring

Use a bearer token to authenticate if you're not using the authtoken header. Format: Bearer . If provided, the organization_uid header isn't required.

authtokenoptionalstring

Use an authentication token if the Authorization header isn't provided. **Requires the organization_uid header.** When using authtoken authentication, you must explicitly provide the organization_uid header. The organization_uid cannot be derived from project_uid for Launch REST APIs.

x-cs-api-versionoptionalstring

Enter the API version. Default is 1.0

organization_uidoptionalstring

⚠️ **REQUIRED when using authtoken authentication** - you must explicitly provide this header. Optional with Authorization Bearer token (organization_uid can be derived from the token).

Sample Response

Status|200 OK

{
  "uploadUrl": "https://test-upload-url.com",
  "expiresIn": 900,
  "uploadUid": "50xxxxa8",
  "method": "POST",
  "fields": [
    {
      "formFieldKey": "bucket",
      "formFieldValue": "

Get a Signed Upload URL for a Deployment

GEThttps://launch-api.contentstack.com/projects/{project_uid}/environments/{environment_uid}/deployments/upload/signed_url

The Get a Signed Upload URL for a Deployment request retrieves the details of the signed URL where you must upload the file when creating or redeploying a deployment.

As the next step, Upload Your Deployment Zip File to the Signed URL.

Hide Parameters

URL Parameters

environment_uidrequiredstring

Enter the environment_uid of the environment where you want to create the deployment.

project_uidrequiredstring

Enter the project_uid of the FILEUPLOAD project where the environments belong.

Headers

authorizationoptionalstring

Use a bearer token to authenticate if you're not using the authtoken header. Format: Bearer . If provided, the organization_uid header isn't required.

authtokenoptionalstring

Use an authentication token if the Authorization header isn't provided. **Requires the organization_uid header.** When using authtoken authentication, you must explicitly provide the organization_uid header. The organization_uid cannot be derived from project_uid for Launch REST APIs.

x-cs-api-versionoptionalstring

Enter the API version. Default is 1.0

organization_uidoptionalstring

⚠️ **REQUIRED when using authtoken authentication** - you must explicitly provide this header. Optional with Authorization Bearer token (organization_uid can be derived from the token).

Sample Response

Status|200 OK

{
  "uploadUrl": "https://test-upload-url.com",
  "expiresIn": 900,
  "uploadUid": "50xxxxa8",
  "method": "POST",
  "fields": [
    {
      "formFieldKey": "bucket",
      "formFieldValue": "

Get a Download URL for a Deployment

GET

https://launch-api.contentstack.com/projects/{project_uid}/environments/{environment_uid}/deployments/{deployment_uid}/download/signed_url

The Get a Download URL for the Uploaded File request returns the signed URL to download the uploaded file from the latest deployment.

Hide Parameters

URL Parameters

deployment_uidrequiredstring

Deployment unique identifier of the latest deployment of an environment for which you want to fetch the download URL.

environment_uidrequiredstring

Environment unique identifier associated with the deployment.

project_uidrequiredstring

Project unique identifier of the FILEUPLOAD project where the environments belong.

Headers

authorizationoptionalstring

Use a bearer token to authenticate if you're not using the authtoken header. Format: Bearer . If provided, the organization_uid header isn't required.

authtokenoptionalstring

Use an authentication token if the Authorization header isn't provided. **Requires the organization_uid header.** When using authtoken authentication, you must explicitly provide the organization_uid header. The organization_uid cannot be derived from project_uid for Launch REST APIs.

x-cs-api-versionoptionalstring

Enter the API version. Default is 1.0

organization_uidoptionalstring

⚠️ **REQUIRED when using authtoken authentication** - you must explicitly provide this header. Optional with Authorization Bearer token (organization_uid can be derived from the token).

Sample Response

Status|200 OK

{
  "downloadUrl": "https://test-download-url.com",
  "expiresIn": 900
}