Admiral

Environment components

List live components in one environment or across all

GET
/v1/environment-components

Scope: env:read

Authorization

bearerAuth
AuthorizationBearer <token>

An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...

In: header

Query Parameters

environment_id?environment_id

The environment to list. Omitted lists across every environment.

Match^env-[0-9a-z]+$
filter?filter

Filter expression to narrow results. Uses the Admiral filter DSL.

Filterable fields:

  • name: filter by component name.
  • kind: filter by component kind.
  • component_id: the registry component (cmp-) it runs.
  • version_id: the registry version (ver-) it runs.

Example: field['component_id'] = 'cmp-7q2k9m4x8p1c' AND field['version_id'] = 'ver-3k9x2m7qpl0a'

Lengthlength <= 1024
page_size?page_size

Maximum number of components 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/environment-components"
{  "components": [    {      "name": "string",      "environment_id": "string",      "kind": "COMPONENT_KIND_UNSPECIFIED",      "version": {        "component_id": "string",        "version_id": "string",        "digest": "string",        "reference": "string"      },      "last_apply": {        "change_set_id": "string",        "revision_id": "string",        "applied_at": "2023-01-15T01:30:15.01Z"      }    }  ],  "next_page_token": "string",  "unreadable_environments": 0}