Environments
Update an environment
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).
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://api.admiral.io/api/v1/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "environment": { "id": "e5f6a7b8-9012-3cde-f456-789012345678", "application_id": "a1b2c3d4-5678-9abc-def0-1234567890ab", "name": "staging", "description": "Shared staging environment for QA validation before production promotion.", "labels": { "region": "us-east-1", "tier": "staging" }, "has_pending_changes": true, "last_deployed_at": "2025-11-01T09:15:00Z", "created_by": { "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "display_name": "Alex Chen", "email": "[email protected]" }, "created_at": "2025-09-15T11:00:00Z", "updated_at": "2025-11-02T14:30:00Z" } }'{ "environment": { "id": "e5f6a7b8-9012-3cde-f456-789012345678", "application_id": "a1b2c3d4-5678-9abc-def0-1234567890ab", "name": "staging", "description": "Shared staging environment for QA validation before production promotion.", "labels": { "region": "us-east-1", "tier": "staging" }, "has_pending_changes": true, "last_deployed_at": "2025-11-01T09:15:00Z", "created_by": { "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "display_name": "Alex Chen", "email": "[email protected]" }, "created_at": "2025-09-15T11:00:00Z", "updated_at": "2025-11-02T14:30:00Z" }}List variables for an environment GET
Sensitive variable values are masked in the response. Scope: `var:read`
Check service health GET
Healthcheck verifies that the service is running and healthy. Returns an empty response on success. Use this endpoint for load balancer health checks and monitoring systems.