Admiral

Jobs

Retrieve a job

GET
/v1/jobs/{job_id}

Scope: agent:read

Authorization

bearerAuth
AuthorizationBearer <token>

An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...

In: header

Path Parameters

job_id*job_id

The job_id path parameter.

Match^job-[0-9a-z]+$

Response Body

application/json

curl -X GET "https://example.com/v1/jobs/string"
{  "job": {    "id": "string",    "kind": "JOB_KIND_UNSPECIFIED",    "status": "JOB_STATUS_UNSPECIFIED",    "agent_id": "string",    "environment_id": "string",    "run_id": "string",    "assignment_id": "string",    "components": [      "string"    ],    "artifact_digest": "string",    "attempt": 0,    "wait_reason": "WAIT_REASON_UNSPECIFIED",    "result": {      "status": "JOB_STATUS_SUCCEEDED",      "message": "string",      "steps": [        {          "component": "string",          "status": "JOB_STATUS_UNSPECIFIED",          "message": "string",          "failure": "FAILURE_UNSPECIFIED"        }      ],      "plan": {        "components": [          {            "component": "string",            "changes": [              {                "resource": {                  "kubernetes": {                    "api_version": "string",                    "kind": "string",                    "namespace": "string",                    "name": "string"                  }                },                "action": "ACTION_UNSPECIFIED",                "diff_digest": "string"              }            ],            "plan_file_digest": "string",            "deferred": {              "waits_for": [                {                  "path": "string",                  "component": "string",                  "output": "string"                }              ]            }          }        ],        "diff_digest": "string"      },      "inventory": [        {          "component": "string",          "resources": [            {              "kubernetes": {                "api_version": "string",                "kind": "string",                "namespace": "string",                "name": "string"              }            }          ]        }      ],      "outputs": [        {          "component": "string",          "outputs": [            {              "name": "string",              "value": null,              "sensitive": true            }          ]        }      ],      "hooks": [        {          "name": "string",          "phase": "PHASE_UNSPECIFIED",          "component": "string",          "passed": true,          "exit_code": 0,          "summary": "string",          "findings": [            {              "message": "string",              "location": "string"            }          ],          "log_offset": "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",    "deferred": [      "string"    ]  }}