Variables
List variables
The returned list is a resolved view based on the provided filters:
- No application_id or environment_id: global variables only.
- application_id only: global + app-level variables merged.
- application_id + environment_id: global + app + environment variables merged.
When variables with the same key exist at multiple levels, all are returned so clients can determine precedence.
Scope: var: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 using the PEG filter DSL.
Common filter fields:
application_id-- scope to an application (triggers merge with app-level variables alongside global variables).environment_id-- scope to an environment (requires application_id; triggers merge with environment-level variables).sensitive-- filter by sensitivity.type-- filter by variable type.key-- filter by variable key (supports prefix matching).
Length
length <= 1024page_size?page_size
Maximum number of variables 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/variables"{ "variables": [ { "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789", "key": "DATABASE_URL", "value": "postgresql://db.internal:5432/inventory", "sensitive": false, "type": "VARIABLE_TYPE_STRING", "scope": "VARIABLE_SCOPE_ENVIRONMENT", "description": "Primary database connection string for the inventory service.", "application_id": "a1b2c3d4-5678-9abc-def0-1234567890ab", "environment_id": "e5f6a7b8-9012-3cde-f456-789012345678", "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "created_at": "2025-09-16T12:00:00Z", "updated_at": "2025-10-30T15:00:00Z" } ], "next_page_token": "string"}