Admiral

Jobs

List jobs

GET
/v1/jobs

Scope: agent:read

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer admp_...

In: header

Query Parameters

agent_id?agent_id

The agent_id query parameter.

Formatuuid
environment_id?environment_id

The environment_id query parameter.

Formatuuid
status?status

UNSPECIFIED lists every status. enum.defined_only = true

Value in

  • "JOB_STATUS_UNSPECIFIED"
  • "QUEUED"
  • "OFFERED"
  • "RUNNING"
  • "SUCCEEDED"
  • "FAILED"
  • "CANCELLED"
page_size?page_size

The page_size query parameter.

Formatint32
Range0 <= value <= 100
page_token?page_token

The page_token query parameter.

Response Body

application/json

curl -X GET "https://example.com/v1/jobs"
{  "jobs": [    {      "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"    }  ],  "next_page_token": "string"}