Admiral

Changesets

List change sets

GET
/v1/changesets

Scope: changeset: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_id query parameter.

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

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

Filterable fields:

  • status: filter by change set status.
  • title: filter by title.

Example: field['status'] = 'STATUS_OPEN'

Lengthlength <= 1024
page_size?page_size

The page_size query parameter.

Formatint32
Range0 <= value <= 100
page_token?page_token

The page_token query parameter.

Response Body

application/json

curl -X GET "https://example.com/v1/changesets?environment_id=string"
{  "change_sets": [    {      "id": "string",      "application_id": "string",      "environment_id": "string",      "title": "string",      "description": "string",      "status": "STATUS_UNSPECIFIED",      "head_revision": 0,      "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",      "reverts_change_set_id": "string",      "behind": true,      "latest_run_id": "string",      "reverted_by_change_set_id": "string"    }  ],  "next_page_token": "string"}