Admiral
Connections

List connections

GET
/api/v1/connections

Scope: connection: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:

  • name -- filter by connection name.
  • type -- filter by connection type (GIT_TOKEN, HELM_HTTP, etc.).
  • status -- filter by connection status (ACTIVE, ERROR, UNTESTED).
  • labels.key -- filter by label key.

Example: field['type'] = 'GIT_TOKEN' AND field['status'] = 'ACTIVE'

Lengthlength <= 1024
page_size?page_size

Maximum number of connections to return per page.

Formatint32
Range0 <= value <= 100
page_token?page_token

Opaque pagination token from a previous response.

Response Body

application/json

curl -X GET "https://admiral.example.com/api/v1/connections"
{  "connections": [    {      "id": "b8c9d0e1-2345-6fab-cdef-0123456789ab",      "name": "ecr-prod",      "description": "Read-only access to production ECR registry for container image pulls.",      "type": "CONNECTION_TYPE_DOCKER_REGISTRY",      "status": "CONNECTION_STATUS_ACTIVE",      "labels": {        "cloud": "aws",        "team": "platform"      },      "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",      "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",      "created_at": "2025-07-20T14:00:00Z",      "updated_at": "2025-10-15T10:30:00Z",      "last_tested_at": "2025-11-01T08:00:00Z"    }  ],  "next_page_token": "string"}

Retrieve a connection GET

Returns connection metadata and status. Sensitive credential fields are never included in the response. Scope: `connection:read`

Test a connection POST

This operation makes a network call to the external system and may take several seconds depending on the remote endpoint. Scope: `connection:write`