Admiral
Changesets

Set a variable

PUT
/api/v1/changesets/{change_set_id}/variables/{key}

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

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

The variable key.

Match^[A-Za-z_][A-Za-z0-9_]{0,62}$
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/variables/string" \  -H "Content-Type: application/json" \  -d '{    "change_set_id": "string",    "value": "string"  }'
{  "variable_entry": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "change_set_id": "14a1580e-9582-45fb-93f1-d323ee91538c",    "key": "string",    "value": "string",    "type": "VARIABLE_TYPE_UNSPECIFIED",    "sensitive": true,    "created_at": "2023-01-15T01:30:15.01Z"  }}

Add or update an entry PUT

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`

Update a change set PATCH

Rejected when the change set is not OPEN. Scope: `app:write`