Jobs
Cancel a job
Scope: agent: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
job_id*job_id
The job_id path parameter.
Format
uuidResponse Body
application/json
curl -X POST "https://example.com/v1/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"{ "job": { "id": "string", "kind": "JOB_KIND_UNSPECIFIED", "status": "JOB_STATUS_UNSPECIFIED", "agent_id": "string", "environment_id": "string", "change_set_id": "string", "revision": 0, "artifact_digest": "string", "attempt": 0, "wait_reason": "WAIT_REASON_UNSPECIFIED", "result": { "status": "SUCCEEDED", "message": "string", "steps": [ { "component": "string", "status": "JOB_STATUS_UNSPECIFIED", "message": "string" } ], "plan": { "components": [ { "component": "string", "changes": [ { "resource": { "api_version": "string", "kind": "string", "namespace": "string", "name": "string" }, "action": "RESOURCE_ACTION_UNSPECIFIED", "diff_digest": "string" } ] } ], "diff_digest": "string" }, "inventory": [ { "component": "string", "resources": [ { "api_version": "string", "kind": "string", "namespace": "string", "name": "string" } ] } ] }, "created_at": "2023-01-15T01:30:15.01Z", "started_at": "2023-01-15T01:30:15.01Z", "finished_at": "2023-01-15T01:30:15.01Z" }}