Admiral
Changesets

Add or update an entry

PUT
/api/v1/changesets/{change_set_id}/entries/{component_name}

The change_type field selects the operation:

  • CREATE: add a new component. Requires catalog_item_id. Rejects if a component with the same name already exists in the application.
  • UPDATE: change an existing component. The name must match an existing component in the application. Only non-empty optional fields are recorded as changes.
  • DESTROY: schedule the component for terraform destroy at deploy.
  • ORPHAN: detach from management without destroying infrastructure.

Rejected when the change set is not OPEN.

Scope: app:write

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
component_name*component_name

Component name (stable identifier set at creation). Required.

Match^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
Length1 <= length <= 63

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://api.admiral.io/api/v1/changesets/string/entries/string" \  -H "Content-Type: application/json" \  -d '{    "change_set_id": "string",    "component_name": "string",    "change_type": "CHANGE_SET_ENTRY_TYPE_UNSPECIFIED"  }'
{  "entry": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "change_set_id": "14a1580e-9582-45fb-93f1-d323ee91538c",    "component_id": "string",    "component_name": "string",    "change_type": "CHANGE_SET_ENTRY_TYPE_UNSPECIFIED",    "catalog_item_id": "ab09154e-32b9-4c7b-baeb-072fb240b8d2",    "ref": "string",    "values_template": "string",    "depends_on": [      "string"    ],    "description": "string",    "catalog_item_name": "string",    "created_at": "2023-01-15T01:30:15.01Z",    "updated_at": "2023-01-15T01:30:15.01Z",    "target": {      "agent_id": "string",      "namespace": "string"    }  }}

Remove a variable on apply DELETE

To withdraw the deletion intent before deploy, call SetVariable for the same key with the desired value (which overwrites the tombstone). Rejected when the change set is not OPEN. Scope: `app:write`

Set a variable PUT

To delete a variable on apply, use RemoveVariable; it writes a tombstone entry on the change set so the apply phase removes the key. Rejected when the change set is not OPEN. Scope: `app:write`