Get job detail

GET 
/job/:id

Retrieve details of a specific job by its ID.

Request

Path Parameters

id uuidrequired

UUID of the job to retrieve.

Responses

200

The job details.

application/json

Schema

Schema

id uuid

Unique identifier of the job.

status string

Current status of the job.

created string

Creation timestamp.

operation

object

The operation data.

property name* any

The operation data.

result

The result data if completed.

changed booleannullable

Whether the operation modified system state. Null for pending/failed jobs; true/false for completed jobs.

error string

Error message if failed.

hostname string

Agent hostname that processed the job.

updated_at string

Last update timestamp.

responses

object

Per-agent response data for broadcast jobs.

property name*

object

status string

data

Agent result data.

changed booleannullable

error string

hostname string

agent_states

object

Per-agent processing state for broadcast jobs.

property name*

object

status string

error string

duration string

timeline

object[]

Chronological sequence of job lifecycle events.

Array [

timestamp string

ISO 8601 timestamp of the event.

event string

Event type (submitted, acknowledged, started, completed, failed, retried).

hostname string

Agent or source that generated the event.

message string

Human-readable description of the event.

error string

Error details if applicable.

]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "string",
  "created": "string",
  "operation": {},
  "changed": true,
  "error": "string",
  "hostname": "string",
  "updated_at": "string",
  "responses": {},
  "agent_states": {},
  "timeline": [
    {
      "timestamp": "string",
      "event": "string",
      "hostname": "string",
      "message": "string",
      "error": "string"
    }
  ]
}

400

Invalid request parameters.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

404

Job not found.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error retrieving job.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...