/

/Ratus

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v1

latestOpenAPI 3.0.1Apache License 2.02026-07-17231129.6 KB

health

Check the liveness of the instance

get/livez

Response

OK

All 23 operations

get Check the liveness of the instance
get Get Prometheus metrics of the instance
get Check the readiness of the instance
get List all topics
delete Delete all topics and tasks
get Get information about a topic
delete Delete a topic and its tasks
get List all promises in a topic
post Make a promise to claim and execute the next available task in a topic
delete Delete all promises in a topic
get Get a promise by the unique ID of its target task
put Make a promise to claim and execute a task regardless of its current state
post Make a promise to claim and execute a task if it is in pending state
delete Delete a promise by the unique ID of its target task
get List all tasks in a topic
put Insert or update a batch of tasks
post Insert a batch of tasks while ignoring existing ones
delete Delete all tasks in a topic
get Get a task by its unique ID
put Insert or update a task
post Insert a new task
delete Delete a task by its unique ID
patch Apply a set of updates to a task and return the updated task