Operator

Use these endpoints to manage Operator operations on a Crate Operator host. The reference below includes request attributes, response shapes, and executable request examples.

The Operator object

Required attributes

callback_url string
update_process_id string
version string

Optional attributes

artifact_source string | null

Source location for the operator binary (S3/R2 bucket URL or HTTPS prefix). If omitted, falls back to the community edition artifact source.

checksum string
POST /v1/operator/update

Trigger asynchronous operator update

Request attributes

Required attributes

callback_url string
update_process_id string
version string

Optional attributes

artifact_source string | null

Source location for the operator binary (S3/R2 bucket URL or HTTPS prefix). If omitted, falls back to the community edition artifact source.

checksum string

Responses

202 Accepted
400 Bad Request
GET /v1/operator/update/{update_process_id}

Get operator update status

Parameters

update_process_id string path required

Responses

200 Operator update status
404 Not Found
GET /v1/operator/running-instance

Get current active operator instance

Responses

200 OK
503 Running instance unavailable