Admiral
Components

Set a component override

PUT
/api/v1/components/{component_id}/overrides/{environment_id}

For example, a "redis" component might use a Helm chart source in dev but a Terraform ElastiCache module in prod.

This is an upsert -- if an override already exists for this component + environment combination, it is replaced.

Scope: env:write

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

Path Parameters

component_id*component_id

The component to override (UUID).

Formatuuid
environment_id*environment_id

The environment this override applies to (UUID).

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://admiral.example.com/api/v1/components/497f6eca-6276-4993-bfeb-53cbbbba6f08/overrides/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "override": {    "component_id": "41afafe5-2a48-424a-baef-34c2ad44ef7b",    "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",    "disabled": true,    "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",    "version": "string",    "values_template": "string",    "depends_on": [      "497f6eca-6276-4993-bfeb-53cbbbba6f08"    ],    "outputs": [      {        "name": "string",        "value_template": "string",        "description": "string"      }    ],    "created_by": {      "id": "string",      "display_name": "string",      "email": "string"    },    "updated_by": {      "id": "string",      "display_name": "string",      "email": "string"    },    "created_at": "2023-01-15T01:30:15.01Z",    "updated_at": "2023-01-15T01:30:15.01Z"  }}

List components GET

The response behavior depends on the filter: - Filter by `application_id` only: returns application-level component definitions (defaults). - Filter by `application_id` + `environment_id`: returns the resolved view with environment overrides applied. Disabled components are included with `disabled=true`. The `has_override` field indicates whether the component differs from its application-level default. Scope: `app:read`

Update a component PATCH

When renaming a component, the server validates that no other components reference the old name in their values_template expressions and rejects the rename if references exist. Scope: `app:write`