Skip to main content
PATCH
Patch Guardrail

Path Parameters

guardrail_id
string<uuid>
required

Body

application/json

Body for PATCH /admin/api/v1/guardrails/{id}.

All fields are optional; absence means no change. Sending null on name is rejected (clearing the row name is meaningless).

name
string | null
enabled
boolean | null
position
enum<string> | null
Available options:
input,
output
sortOrder
integer | null
Required range: x >= 0
guardrail
SimpleBanListConfig · object

Response

Successful Response

data
StandaloneGuardrailRead · object
required

GET response and the data payload of POST/PATCH/DELETE responses.

reload
StandaloneReloadResult · object
required

Reload outcome attached to every admin mutation response.

reloaded means DB committed and runtime now uses the new config. restart_required means DB committed and process restart is needed. reload_failed means DB rolled back and runtime is unchanged.

Last modified on May 22, 2026