Create a new job

POST 
/job

Submit a new job to the queue for processing.

Request

application/json

Body

required

The job to create.

operation

object

required

The operation to perform, as a JSON object.

property name* any

The operation to perform, as a JSON object.

target_hostname stringrequired

The target hostname for routing (_any, _all, or specific hostname).

Responses

201

The job was created successfully.

application/json

Schema

Schema

job_id stringrequired

Unique identifier for the created job.

status stringrequired

Initial status of the job.

revision int64

The KV revision number.

timestamp string

Creation timestamp.

Example (from schema)

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "unprocessed",
  "revision": 1,
  "timestamp": "2025-06-14T10:00:00Z"
}

400

Invalid request payload.

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
}

500

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