Get job detail

GET 
/job/:id

Retrieve details of a specific job by its ID.

Request

Path Parameters

id stringrequired

Responses

200

The job details.

application/json

Schema

Schema

id string

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.

error string

Error message if failed.

hostname string

Worker hostname that processed the job.

updated_at string

Last update timestamp.

Example (from schema)

{
  "id": "string",
  "status": "string",
  "created": "string",
  "operation": {},
  "error": "string",
  "hostname": "string",
  "updated_at": "string"
}

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...