Skip to navigation
ReferenceAPI Gateway HTTP referenceHeimdall Service

Get job by ID

View as Markdown
Retrieve a specific job by its UUID.

Path parameters

heimdallJobIdstringRequired
The job identifier.

Query parameters

useHeimdallIdbooleanOptional

If true, interpret heimdall_job_id as a UUID and query by heimdall_job_id directly. If false or not set (default), parse as “{job_id}-{attempt_index}” format.

Response

A successful response.
jobobjectOptional

Job represents a job tracked by the Advisor, including both actual (observed) and desired (advisor-set) states.