Create a variable

Fails if a variable with the same key already exists at the same level (same key + application_id + environment_id combination).

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

key?key

The variable name. Must be a valid environment variable identifier (e.g., "DATABASE_URL", "API_KEY").

Match^[A-Za-z_][A-Za-z0-9_]{0,62}$

Length1 <= length <= 63

value?value

The variable value. For COMPLEX type, must be valid JSON.

Length1 <= length

sensitive?sensitive

Whether the variable value should be encrypted at rest and masked in API responses.

type?type

How the value should be interpreted. Defaults to STRING if not specified.

Value in

"VARIABLE_TYPE_UNSPECIFIED" | "VARIABLE_TYPE_STRING" | "VARIABLE_TYPE_NUMBER" | "VARIABLE_TYPE_BOOLEAN" | "VARIABLE_TYPE_COMPLEX"

description?description

Optional description of the variable's purpose.

Lengthlength <= 1024

application_id?|

The application to scope this variable to (UUID). When set without environment_id, the variable applies to all environments in the app.

Formatuuid

environment_id?|

The environment to scope this variable to (UUID). Requires application_id. When set, the variable applies only to this specific environment.

Formatuuid

Response Body

`application/json`

curl -X POST "https://admiral.example.com/api/v1/variables" \  -H "Content-Type: application/json" \  -d '{}'

{  "variable": {    "id": "1a2b3c4d-5e6f-7890-abcd-ef0123456789",    "key": "DATABASE_URL",    "value": "postgresql://db.internal:5432/inventory",    "sensitive": false,    "type": "VARIABLE_TYPE_STRING",    "scope": "VARIABLE_SCOPE_ENVIRONMENT",    "description": "Primary database connection string for the inventory service.",    "application_id": "a1b2c3d4-5678-9abc-def0-1234567890ab",    "environment_id": "e5f6a7b8-9012-3cde-f456-789012345678",    "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",    "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",    "created_at": "2025-09-16T12:00:00Z",    "updated_at": "2025-10-30T15:00:00Z"  }}

Create a variable

Authorization

Request Body

Response Body

200application/json

`application/json`