Admiral
Environments

List environments

GET
/v1/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 admp_...

In: header

Query Parameters

filter?filter

Filter expression to narrow results. Uses the Admiral filter DSL (see the API documentation for the full operator and predicate reference).

Filterable fields:

  • application_id: filter by parent application (UUID).
  • name: filter by environment name.
  • labels.key: filter by label key.

Example: field['application_id'] = '<uuid>' AND field['name'] = 'prod'

Lengthlength <= 1024
page_size?page_size

Maximum number of environments to return per page. Defaults to 50 when omitted or 0; must not exceed 100.

Formatint32
Range0 <= value <= 100
page_token?page_token

Opaque pagination token from a previous response.

Response Body

application/json

curl -X GET "https://example.com/v1/environments"
{  "environments": [    {      "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"    }  ],  "next_page_token": "string"}

List components deployed to an environment GET

Components without a SUCCEEDED revision (e.g. CREATE entries that failed mid-plan) still appear, with `last_revision_status` and `last_deployed_at` empty. Scope: `env:read`

List variables for an environment GET

Sensitive variable values are masked in the response. Scope: `var:read`