Connections
Update a connection
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
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
connection.id*id
Unique identifier for the connection (UUID).
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://admiral.example.com/api/v1/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "connection": { "id": "b8c9d0e1-2345-6fab-cdef-0123456789ab", "name": "ecr-prod", "description": "Read-only access to production ECR registry for container image pulls.", "type": "CONNECTION_TYPE_DOCKER_REGISTRY", "status": "CONNECTION_STATUS_ACTIVE", "labels": { "cloud": "aws", "team": "platform" }, "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "created_at": "2025-07-20T14:00:00Z", "updated_at": "2025-10-15T10:30:00Z", "last_tested_at": "2025-11-01T08:00:00Z" } }'{ "connection": { "id": "b8c9d0e1-2345-6fab-cdef-0123456789ab", "name": "ecr-prod", "description": "Read-only access to production ECR registry for container image pulls.", "type": "CONNECTION_TYPE_DOCKER_REGISTRY", "status": "CONNECTION_STATUS_ACTIVE", "labels": { "cloud": "aws", "team": "platform" }, "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "created_at": "2025-07-20T14:00:00Z", "updated_at": "2025-10-15T10:30:00Z", "last_tested_at": "2025-11-01T08:00:00Z" }}