Admiral
Credentials

List credentials

GET
/api/v1/credentials

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

  • name: filter by credential name.
  • type: filter by credential type (SSH_KEY, BASIC_AUTH, BEARER_TOKEN).
  • labels.key: filter by label key.

Example: field['type'] = 'BEARER_TOKEN'

Lengthlength <= 1024
page_size?page_size

Maximum number of credentials 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://api.admiral.io/api/v1/credentials"
{  "credentials": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "description": "string",      "type": "CREDENTIAL_TYPE_UNSPECIFIED",      "auth_config": {        "basic_auth": {          "username": "string",          "password": "string"        }      },      "labels": {        "property1": "string",        "property2": "string"      },      "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"}

Retrieve a credential GET

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

Update a credential PATCH

When updating auth_config, the entire auth config is replaced. Partial updates within the auth config oneof are not supported. Omitting auth_config from the update_mask leaves credentials unchanged. Scope: `credential:write`