Get job

Read the current state of asynchronous work.

GET/jobs/{job_id}

PermissionCluster key, or a scoped key with read (write includes read). Key scopes and actions.

Use events webhooks for live status. Read the job to inspect its current state or recover after a missed event.
A terminal job can be succeeded, failed, or canceled. Inspect error when a job fails.

Request

https://engine.example.com/jobs/job_01K6Q6N7D8E9F0G1H2J3K4M5N6

GET /jobs/job_01K6Q6N7D8E9F0G1H2J3K4M5N6 HTTP/1.1
Host: engine.example.com
Authorization: Bearer <GRAPHON_ENGINE_API_KEY>

Replace engine.example.com with your cluster host. Examples use a key placeholder.

Response

200

The current job state. This example shows successful completion.

{
  "id": "job_01K6Q6N7D8E9F0G1H2J3K4M5N6",
  "type": "index_file",
  "status": "succeeded",
  "namespace": "acme",
  "collection": "incident-logs",
  "file_id": "fil_01K6Q6N7D8E9F0G1H2J3K4M5N6",
  "error": null,
  "created_at": "2026-10-06T10:00:00Z",
  "updated_at": "2026-10-06T10:00:00Z"
}

Path parameters

job_idstringrequired

Public job ID with the job_ prefix, returned by the operation that started the work.

Responses

200Success

The current job state. This example shows successful completion.

application/json

Response headers

x-engine-request-idstringrequired

The Engine request ID. Retain it when investigating a failed or unexpected request.

x-request-idstringrequired

The X-Request-Id you sent, echoed when it is a valid ID. Otherwise, the Engine request ID.

collectionstringoptionalaccepts null

Collection name when this job belongs to a collection. Otherwise omitted.

created_atstring (date-time)required

Time the resource was created, as an ISO 8601 UTC timestamp.

errorobjectrequiredaccepts null

Failure details, or null when no failure is recorded.

file_idstringoptionalaccepts null

File ID when this job acts on one file. Otherwise omitted.

idstringrequired

Immutable job ID with the job_ prefix. Use it to read the current state.

namespacestringoptionalaccepts null

Namespace name when this job belongs to a namespace.

statusstringrequired

Current state of the asynchronous work. succeeded, failed, and canceled are terminal states.

queued: Accepted and waiting to start.
running: Work is in progress.
succeeded: Work completed successfully.
failed: Work ended with an error.
canceled: Work ended after cancellation.

typestringrequired

Kind of work accepted by the API.

index_file: Index a new or replacement file.
delete_file: Remove a file and clean its derived data.
reindex_collection: Rebuild the collection’s derived data.
delete_collection: Remove a collection and its derived data.
delete_namespace: Remove a namespace and its collections.
apply_access_rule: Apply changed governing rules to affected files.
reindex_metadata: Rebuild the metadata index after a change of the metadata fields.