Sources
Update a source
Scope: source: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
source.id*id
Unique identifier for the source (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/sources/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "source": { "id": "f6a7b8c9-0123-4def-5678-901234567890", "name": "nginx-ingress", "description": "NGINX Ingress Controller Helm chart from the official repository.", "type": "SOURCE_TYPE_HELM_REPOSITORY", "url": "https://kubernetes.github.io/ingress-nginx", "catalog": true, "labels": { "category": "networking", "team": "platform" }, "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "created_at": "2025-08-01T12:00:00Z", "updated_at": "2025-10-20T09:00:00Z" } }'{ "source": { "id": "f6a7b8c9-0123-4def-5678-901234567890", "name": "nginx-ingress", "description": "NGINX Ingress Controller Helm chart from the official repository.", "type": "SOURCE_TYPE_HELM_REPOSITORY", "url": "https://kubernetes.github.io/ingress-nginx", "catalog": true, "labels": { "category": "networking", "team": "platform" }, "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "updated_by": "d290f1ee-6c54-4b01-90e6-d701748f0851", "created_at": "2025-08-01T12:00:00Z", "updated_at": "2025-10-20T09:00:00Z" }}Sync a source POST
Use this after updating credentials on the referenced connection, or to force a refresh when you know the upstream has changed. This operation queries the external system in real time and may take several seconds. Scope: `source:write`
Delete a state DELETE
Returns NOT_FOUND if the state record does not exist. Returns FAILED_PRECONDITION if the state is currently locked. Scope: `state:admin`