Environments
List environments
Scope: env:read
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
Query Parameters
filter?filter
Filter expression to narrow results. Uses the Admiral filter DSL.
Syntax: field['name'] = 'value' with AND/OR/NOT, comparison operators
(=, !=, <, >, <=, >=, ~=), and predicates (IN, BETWEEN, CONTAINS,
STARTS_WITH, ENDS_WITH, IS NULL, EXISTS).
Filterable fields:
application_id-- filter by parent application (UUID).name-- filter by environment name.workload_type-- filter by workload target type (KUBERNETES).infrastructure_type-- filter by infrastructure target type (TERRAFORM).labels.key-- filter by label key.
Example: field['application_id'] = '<uuid>' AND field['name'] = 'prod'
Length
length <= 1024page_size?page_size
Maximum number of environments to return per page.
Format
int32Range
0 <= value <= 100page_token?page_token
Opaque pagination token from a previous response.
Response Body
application/json
curl -X GET "https://admiral.example.com/api/v1/environments"{ "environments": [ { "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" } ], "next_page_token": "string"}