Jobs

Get a job

GET/jobs/{id}

Returns one job: its status, its progress and, once it has succeeded, its result. Poll it from the Location of the 202 that started it. A failed job carries an error. A token sees only the jobs it started, and any other job id returns 404.

Jobs started before tokens were recorded on them are visible to every token of the organisation that started them. Their type comes from the worker's name and their result is the last progress entry the worker wrote.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

Responses

200

The job.

Job
{
  "data": {
    "id": "4f2b9c1d-8a7e-4d3f-b2c1-6e5a4d3c2b1a",
    "type": "bulk_create",
    "status": "running",
    "progress": {
      "done": 1740,
      "total": 3480
    },
    "result": null,
    "error": null,
    "created_at": "2026-10-28T09:14:08Z",
    "updated_at": "2026-10-28T09:14:33Z",
    "completed_at": null
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/jobs/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"