Create an environment

Scope: env:write

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer admp_...

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

CreateEnvironmentRequest contains the parameters for creating a new environment.

application_id*application_id

The application to create this environment for (UUID).

Formatuuid

name*name

URL-safe, human-readable identifier (e.g., "prod", "staging-us-east"). Unique within the application. Lowercase alphanumeric and hyphens only, must start with a letter and end with an alphanumeric character (1-63 chars).

Match^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$

Length1 <= length <= 63

description?description

Optional longer-form description of the environment's purpose.

Lengthlength <= 1024

labels?

Arbitrary key-value labels for organizing and filtering environments.

Propertiesproperties <= 64

Response Body

`application/json`

curl -X POST "https://example.com/v1/environments" \  -H "Content-Type: application/json" \  -d '{    "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",    "name": "string"  }'

{  "environment": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",    "name": "string",    "description": "string",    "labels": {      "property1": "string",      "property2": "string"    },    "has_pending_changes": true,    "last_deployed_at": "2023-01-15T01:30:15.01Z",    "created_by": {      "id": "string",      "display_name": "string",      "email": "string"    },    "created_at": "2023-01-15T01:30:15.01Z",    "updated_at": "2023-01-15T01:30:15.01Z"  }}

Create an environment

Authorization

Request Body

Response Body

200application/json

`application/json`