Skip to content

API & reference

Validate Tasks

POST
/ratchet/tasks/validate
curl --request POST \
--url http://localhost:8000/ratchet/tasks/validate

A dry run: the errors a body would get, with no side effects. {"tasks": [...]} is checked as startup reads RATCHET_TASKS_FILE (it may adjust or extend a built-in task, never extend an API task, and must fit in the registry with the built-in tasks); one task spec is checked as PUT would take it.

x-api-key
Any of:
string

Successful Response

Media typeapplication/json
Response Validate Tasks Ratchet Tasks Validate Post
object

Example generated

{}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}