Admiral
Deployments

List deployments

GET
/api/v1/deployments

Common filter fields: application_id, environment_id, status, trigger_type. Use to view deployment history for an environment.

Scope: deploy: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 -- deployments for a specific application.
  • environment_id -- deployments to a specific environment.
  • status -- filter by deployment status.
  • trigger_type -- filter by trigger type (MANUAL, CI, DESTROY).
Lengthlength <= 1024
page_size?page_size

Maximum number of deployments 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/deployments"
{  "deployments": [    {      "id": "7e8f9a0b-1c2d-3e4f-5a6b-7c8d9e0f1a2b",      "application_id": "a1b2c3d4-5678-9abc-def0-1234567890ab",      "environment_id": "e5f6a7b8-9012-3cde-f456-789012345678",      "status": "DEPLOYMENT_STATUS_SUCCEEDED",      "version": "42",      "description": "Deploy v2.4.1 with updated ingress rules",      "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",      "created_at": "2025-11-20T14:00:00Z",      "updated_at": "2025-11-20T14:12:00Z",      "completed_at": "2025-11-20T14:12:00Z"    }  ],  "next_page_token": "string"}

Retrieve a revision GET

Scope: `deploy:read`

List revisions GET

Scope: `deploy:read`