Contentstack introduces the Agentic Experience Platform | Press release
Contentstack introduces the Agentic Experience Platform | Press release
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs
  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing
  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases
  • Academy
  • Docs
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP
  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support
  • Overview
  • Find a partner
  • Login
  • About us
  • News
  • Customer support portal
  • Contact
  • Facebook
  • LinkedIn
  • Instagram
  • Github
  • Youtube
  • Discord
  • X

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • Github
  • Youtube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.

AI Assistant

Ask a question below...

infoAI responses may contain mistakes.
/
  1. Home
  2. APIs
  3. Launch API
  4. Deployments

Deployments

markdownView as Markdown

Launch Deployments let you build, preview, and manage your project deployments seamlessly in real time. Whether you are importing code from a Git repository or uploading a ZIP file, each deployment provides detailed insights into build status, logs, and redeployment options—helping you track and manage every release with confidence.

Get all Deployments

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

The Get all Deployments request fetches the list of all deployments within a specific environment of your project.

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627282930313233
{
  "pagination": {
    "count": 1
  },
  "deployments": [
    {
      "uid": "690cxxxxxxxxxxxxx96a",
      "environment": "691xxxxxxxxxxxxxxx1315",
      "project": "691xxxxxxxxxxxxxxxx1316",
      "gitBranch": "main",
      "deploymentUrl": "sample-project.contentstackapps.com",
      "repositoryUrl": "https://github.com/Vaxxxxxxxx20/eleventy-base-blog",
      "commitHash": "4f0axxxxxxxxxxxxb75ea",
      "commitMessage": "Merge pull request #151 from DougReeder/style-src-self\n\nRefactors style bundling so it's easy to avoid an insecure CSP",
      "commitUrl": "https://github.com/Vaxxxxxxxx20/eleventy-base-blog/commit/4f0a64d7xxxxxxxxxxxxxxx2b75ea",
      "buildCommand": "npx @11ty/eleventy",
      "outputDirectory": "./_site",
      "frameworkPreset": "OTHER",
      "isCSRFramework": false,
      "environmentVariables": [],
      "status": "LIVE",
      "isCancellable": false,
      "latest": true,
      "deploymentNumber": 1,
      "createdAt": "2025-11-06T07:39:20.071Z",
      "createdBy": "bltxxxxxxxx5783",
      "previewUrl": "https://images.contentstack.io/v3/assets/bltxxxxxxxxx7b34/bltxxxxxxxx45f/690xxxxxxxxxxxx193/690xxxxxxxxxxc96a-preview.png",
      "updatedAt": "2025-11-06T07:39:58.426Z",
      "durationInSeconds": 25.032954443,
      "nodeVersion": "22"
    }
  ]
}

Create a Deployment

POSThttps://launch-api.contentstack.com/projects/{project_uid}/environments/{environment_uid}/deployments

The Create Deployment request lets you create a new deployment in your Launch project.

The examples below explain how to create deployments using a Git Provider, Newly Uploaded File, or the Previously File Upload option.

Create a Deployment Using a Previously Uploaded File:

{}

To create a deployment using a previously uploaded file, the system uses the most recent file uploaded to your project.

Create a Deployment Using a Newly Uploaded File:

{
  "uploadUid": "133xxxxbe8"
}

To create a deployment using FileUpload, you must run the following APIs step-by-step:

1. Get a Signed Upload URL for a Deployment.

2. Upload your ZIP file to Launch (The signed URL is valid only for 10 minutes).


Sample Request
123
{
  "commitHash": "4f0xxxxxxxxxxxxxxxxxxxxxxxxxxxx75ea"
}
Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728
{
  "deployment": {
    "uid": "690cxxxxxxxxxxxxx96a",
    "environment": "691xxxxxxxxxxxxxxx1315",
    "project": "691xxxxxxxxxxxxxxxx1316",
    "gitBranch": "main",
    "deploymentUrl": "sample-project.contentstackapps.com",
    "repositoryUrl": "https://github.com/Vaxxxxxxxx20/eleventy-base-blog",
    "commitHash": "4f0axxxxxxxxxxxxb75ea",
    "commitMessage": "Merge pull request #151 from DougReeder/style-src-self\n\nRefactors style bundling so it's easy to avoid an insecure CSP",
    "commitUrl": "https://github.com/Vaxxxxxxxx20/eleventy-base-blog/commit/4f0a64d7xxxxxxxxxxxxxxx2b75ea",
    "buildCommand": "npx @11ty/eleventy",
    "outputDirectory": "./_site",
    "frameworkPreset": "OTHER",
    "isCSRFramework": false,
    "environmentVariables": [],
    "status": "LIVE",
    "isCancellable": false,
    "latest": true,
    "deploymentNumber": 1,
    "createdAt": "2025-11-06T07:39:20.071Z",
    "createdBy": "bltxxxxxxxx5783",
    "previewUrl": "https://images.contentstack.io/v3/assets/bltxxxxxxxxx7b34/bltxxxxxxxx45f/690xxxxxxxxxxxx193/690xxxxxxxxxxc96a-preview.png",
    "updatedAt": "2025-11-06T07:39:58.426Z",
    "durationInSeconds": 25.032954443,
    "nodeVersion": "22"
  }
}

Get a Deployment

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

The Get a Deployment request retrieves a specific deployment from an environment of your project in Launch using the project_uid, environment_uid, and deployment_uid path parameters.

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728
{
  "deployment": {
    "uid": "690cxxxxxxxxxxxxx96a",
    "environment": "691xxxxxxxxxxxxxxx1315",
    "project": "691xxxxxxxxxxxxxxxx1316",
    "gitBranch": "main",
    "deploymentUrl": "sample-project.contentstackapps.com",
    "repositoryUrl": "https://github.com/Vaxxxxxxxx20/eleventy-base-blog",
    "commitHash": "4f0axxxxxxxxxxxxb75ea",
    "commitMessage": "Merge pull request #151 from DougReeder/style-src-self\n\nRefactors style bundling so it's easy to avoid an insecure CSP",
    "commitUrl": "https://github.com/Vaxxxxxxxx20/eleventy-base-blog/commit/4f0a64d7xxxxxxxxxxxxxxx2b75ea",
    "buildCommand": "npx @11ty/eleventy",
    "outputDirectory": "./_site",
    "frameworkPreset": "OTHER",
    "isCSRFramework": false,
    "environmentVariables": [],
    "status": "LIVE",
    "isCancellable": false,
    "latest": true,
    "deploymentNumber": 1,
    "createdAt": "2025-11-06T07:39:20.071Z",
    "createdBy": "bltxxxxxxxx5783",
    "previewUrl": "https://images.contentstack.io/v3/assets/bltxxxxxxxxx7b34/bltxxxxxxxx45f/690xxxxxxxxxxxx193/690xxxxxxxxxxc96a-preview.png",
    "updatedAt": "2025-11-06T07:39:58.426Z",
    "durationInSeconds": 25.032954443,
    "nodeVersion": "22"
  }
}
Hide Parameters

URL Parameters

project_uidrequiredstring

Enter the project_uid of your project.

environment_uidrequiredstring

Enter the environment_uid of the environment where the deployments belong.

Query Parameters

skipoptionalstring

The "skip" parameter will skip a specific number of deployments in the output. For example, if there are 20 deployments and you want to skip the first 2 to get only the last 12 in the response body, you need to specify "2" here.

limitoptionalstring

The "limit" parameter will return a specific number of deployments (in between 0-100) in your response based on the value you provide. If there are 20 deployments and you want to fetch only 10 deployments, set the limit as 10.

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).

Hide Parameters

URL Parameters

project_uidrequiredstring

Enter the project_uid of your project.

environment_uidrequiredstring

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

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).

Hide Parameters

URL Parameters

project_uidrequiredstring

Enter the project_uid of your project.

environment_uidrequiredstring

Enter the environment_uid of the environment where the deployments belong.

deployment_uidrequiredstring

Enter the deployment_uid of the deployment that must be retrieved.

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).