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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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"). Must be unique within the application. Lowercase alphanumeric and hyphens only.

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

workload_targets?array<>

Workload runtime targets. Optional -- can be added later via UpdateEnvironment. At most one target per WorkloadType.

infrastructure_targets?array<>

Infrastructure runtime targets. Optional -- can be added later via UpdateEnvironment. At most one target per InfrastructureType.

labels?

Arbitrary key-value labels for organizing and filtering environments.

Propertiesproperties <= 64

Response Body

`application/json`

curl -X POST "https://admiral.example.com/api/v1/environments" \  -H "Content-Type: application/json" \  -d '{}'

{  "environment": {    "id": "e5f6a7b8-9012-3cde-f456-789012345678",    "application_id": "a1b2c3d4-5678-9abc-def0-1234567890ab",    "name": "staging",    "description": "Shared staging environment for QA validation before production promotion.",    "runtime_type": "RUNTIME_TYPE_KUBERNETES",    "labels": {      "region": "us-east-1",      "tier": "staging"    },    "infrastructure": {      "runner_id": "b2c3d4e5-6789-0abc-def1-234567890abc"    },    "kubernetes": {      "cluster_id": "c3d4e5f6-7890-1abc-def0-abcdef012345",      "namespace": "inventory-staging"    },    "has_pending_changes": true,    "last_deployed_at": "2025-11-01T09:15:00Z",    "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",    "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",    "created_at": "2025-09-15T11:00:00Z",    "updated_at": "2025-11-02T14:30:00Z"  }}

Create an environment

Authorization

Request Body

Response Body

200application/json

`application/json`