Cancel a deployment
Scope: deploy:write
Authorization
bearerAuth Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer adm_pat_...
In: header
Path Parameters
Unique identifier of the deployment to cancel (UUID).
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://admiral.example.com/api/v1/deployments/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \ -H "Content-Type: application/json" \ -d '{}'{ "deployment": { "id": "7e8f9a0b-1c2d-3e4f-5a6b-7c8d9e0f1a2b", "application_id": "a1b2c3d4-5678-9abc-def0-1234567890ab", "environment_id": "e5f6a7b8-9012-3cde-f456-789012345678", "status": "DEPLOYMENT_STATUS_SUCCEEDED", "version": "42", "description": "Deploy v2.4.1 with updated ingress rules", "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "created_at": "2025-11-20T14:00:00Z", "updated_at": "2025-11-20T14:12:00Z", "completed_at": "2025-11-20T14:12:00Z" }}Update a connection PATCH
When updating auth_config, the entire auth config is replaced -- partial updates within the auth config oneof are not supported. Omitting auth_config from the update_mask leaves credentials unchanged. Scope: `connection:write`
Create a deployment POST
The server resolves all components (with environment overrides applied), builds the dependency DAG, and begins rendering and executing revisions. To destroy all resources in an environment (e.g., before deleting the environment), set `destroy` to true. This runs Terraform destroy for infrastructure components and deletes workload resources from the cluster, in reverse dependency order. Concurrency: only one deployment can be active per application+environment at a time. If a deployment is already in progress (PENDING or RUNNING), the new deployment is queued and will start automatically when the current deployment completes or is cancelled. Scope: `deploy:write`