Admiral
Changesets

Compute a change set diff

GET
/api/v1/changesets/{change_set_id}/diff

Sensitive values are never returned. Changed-but-masked entries set sensitive=true and omit old/new so the reviewer knows a change is present without seeing the value.

Available for change sets in any status; for non-OPEN change sets the result reflects the diff against the env's CURRENT HEAD, not the env's state at the time the change set was deployed.

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

Path Parameters

change_set_id*change_set_id

Identifier of the change set. Accepts either the short ID (cs-<suffix>) or the canonical UUID.

Length1 <= length

Response Body

application/json

curl -X GET "https://api.admiral.io/api/v1/changesets/string/diff"
{  "diff": {    "entries": [      {        "component_name": "string",        "change_type": "CHANGE_SET_ENTRY_TYPE_UNSPECIFIED",        "catalog_item": {          "catalog_item_id_old": "string",          "catalog_item_id_new": "string",          "catalog_item_name_old": "string",          "catalog_item_name_new": "string",          "ref_old": "string",          "ref_new": "string"        },        "values": [          {            "key": "string",            "change_type": "DIFF_CHANGE_TYPE_UNSPECIFIED",            "old": "string",            "new": "string",            "sensitive": true          }        ],        "depends_on_added": [          "string"        ],        "depends_on_removed": [          "string"        ],        "description_old": "string",        "description_new": "string"      }    ],    "variables": [      {        "key": "string",        "change_type": "DIFF_CHANGE_TYPE_UNSPECIFIED",        "old": "string",        "new": "string",        "sensitive": true      }    ],    "downstream": [      {        "component_name": "string",        "affected_by": [          "string"        ]      }    ]  }}