Skip to content

Admin Settings

PUT
/ratchet/admin/settings
curl --request PUT \
--url http://localhost:8000/ratchet/admin/settings \
--header 'Content-Type: application/json' \
--data '"example"'

Set the runtime audit rate (body {audit_rate, reason, force}; audit_rate 0 to 1, or null for RATCHET_AUDIT_RATE). 0 while a canary is in flight needs force.

x-api-key
Any of:
string
Media typeapplication/json
Body

Example generated

example

Successful Response

Media typeapplication/json
Response Admin Settings Ratchet Admin Settings Put
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"
}
]
}