Admiral
Environments

Update an environment

PATCH
/v1/environments/{environment.id}

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

environment.id*id

Unique identifier for the environment (UUID).

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

UpdateEnvironmentRequest contains the environment fields to update.

Response Body

application/json

curl -X PATCH "https://example.com/v1/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "environment": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",    "name": "string",    "description": "string",    "labels": {      "property1": "string",      "property2": "string"    },    "has_pending_changes": true,    "last_deployed_at": "2023-01-15T01:30:15.01Z",    "created_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 variables for an environment GET

Sensitive variable values are masked in the response. Scope: `var:read`

Invite someone into the current tenant POST

A live invitation for the same address is retired and replaced, so a retry or a "send it again" is this same call. ALREADY_EXISTS when the address is already a member. INVALID_ARGUMENT for a role that cannot be granted by invitation: OWNER moves by transfer, and APP_CREATOR is a capability rather than a role. Scope: `user:write`