Skip to content

You are viewing documentation for Immuta version 2023.4.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

cancel

Jobs API

This page describes the jobs endpoint.

Note

Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.

Get job status and output

Endpoint

Method Path Purpose
POST /jobs/statuses Get the status and output of the provided jobs.

Query Parameters

None.

Payload Parameters

Attribute Description Required
jobIds string List of job IDs. Yes
wait integer Number of seconds to wait before returning if all jobs have not yet completed. Use -1 to wait indefinitely. The default is 0. No
pollInterval integer Number of seconds to wait between subsequent polls. Ignored if not using wait. The default is 1. The minimum is 1. No

Response Parameters

Attribute Description
id string The job's globally unique identifier.
state array[string] The job state: active, cancelled, completed, created, expired, failed, or retry.
output string The output of the job, if it exists.

Request example

The following request checks the status of the job specified in the payload.

curl \
    --request POST \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    --data @example_payload.json
    https://your-immuta-url.com/jobs/statuses

Payload example

{
  "jobIds": [
    "cefb58a0-cd71-11ec-8e29-81c20d280994"
  ],
  "wait": 0,
  "pollInterval": 1
}

Response example

{
  "cefb58a0-cd71-11ec-8e29-81c20d280994": {
    "id": "cefb58a0-cd71-11ec-8e29-81c20d280994",
    "state": "completed",
    "output": null
  }
}