Environments

View as Markdown

Launch environments help you deploy and manage different versions of your project independently. Each environment is auto-deployed to a unique URL and can be customized to match your development workflow.

Get all Environments

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

The Get all Environments request fetches the list of all environments in your project.

Hide Parameters

URL Parameters

project_uidrequiredstring

Enter the project_uid of the project where the environments belong.

Query Parameters

skipoptionalstring

The "skip" parameter will skip a specific number of environments in the output. For example, if there are 20 environments 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 environments (in between 0-100) in your response based on the value you provide. If there are 20 environments and you want to fetch only 10 environments, 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).

Sample Response

Status|200 OK

{
  "pagination": {
    "count": 1,
    "limit": 10,
    "skip": 0
  },
  "environments": [
    {
      "uid": "690xxxxxxxxxxxxxx95f",
      "name": "Test Environment",
      "description": "It is a test environment.",
      "project": "691xxxxxxxxxxxxx9103",
      "gitBranch": "main",
      "buildCommand": "npx @11ty/eleventy",
      "outputDirectory": "./_site",
      "frameworkPreset": "OTHER",
      "environmentVariables": [
        {
          "key": "key1",
          "value": "value1"
        }
      ],
      "autoDeployOnPush": true,
      "nodeVersion": "22",
      "organizationUid": "bltxxxxxxxxxxxx3589",
      "createdAt": "2025-11-06T07:39:19.230Z",
      "updatedAt": "2025-11-06T07:39:53.582Z",
      "createdBy": "bltxxxxxxxxxxxx5783",
      "updatedBy": "bltxxxxxxxxxxxx5783",
      "hasLyticsEnabled": false,
      "isCachePrimingEnabled": false,
      "passwordProtection": {
        "isEnabled": false
      }
    }
  ]
}

Create an Environment

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

Get an Environment

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

Update an Environment

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

Delete an Environment

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

The Delete an Environment request lets you delete an existing environment in your project.

Revalidate CDN Cache

POSThttps://launch-api.contentstack.com/projects/{project_uid}/environments/{environment_uid}/revalidate-cdn-cache

{ "pagination": { "count": 1, "limit": 10, "skip": 0 }, "environments": [ { "uid": "690xxxxxxxxxxxxxx95f", "name": "Test Environment", "description": "It is a test environment.", "project": "691xxxxxxxxxxxxx9103", "gitBranch": "main", "buildCommand": "npx @11ty/eleventy", "outputDirectory": "./_site", "frameworkPreset": "OTHER", "environmentVariables": [ { "key": "key1", "value": "value1" } ], "autoDeployOnPush": true, "nodeVersion": "22", "organizationUid": "bltxxxxxxxxxxxx3589", "createdAt": "2025-11-06T07:39:19.230Z", "updatedAt": "2025-11-06T07:39:53.582Z", "createdBy": "bltxxxxxxxxxxxx5783", "updatedBy": "bltxxxxxxxxxxxx5783", "hasLyticsEnabled": false, "isCachePrimingEnabled": false, "passwordProtection": { "isEnabled": false } } ] }

Environments

Get all Environments

URL Parameters

Query Parameters

Headers

Create an Environment

Get an Environment

Update an Environment

Delete an Environment

Revalidate CDN Cache

Environments

Get all Environments

URL Parameters

Query Parameters

Headers

Create an Environment

Get an Environment

Update an Environment

Delete an Environment

Revalidate CDN Cache

Create an Environment by FileUpload:

URL Parameters

Headers

URL Parameters

Headers

URL Parameters

Headers

URL Parameters

Headers

Purge cache of a specific path:

Purge cache by cache tags:

Purge cache for specific hostnames:

URL Parameters

Headers

URL Parameters

Headers

URL Parameters

Headers

URL Parameters

Headers

URL Parameters

Headers

URL Parameters

Headers