Sign in
organization-guardrails

Update Organization Guardrail

Change a guardrail's profile, endpoint, credential, modes, or scope.

Organization owners and admins only. Omitted fields are left as they are; workspace_ids replaces the scope whole when sent, and url and credential are cleared by sending an empty string rather than null.

patch/v1/organizations/me/guardrails/{guardrail_id}

Path parameters

guardrail_idstring uuid required

Request body

applies_to_all_workspacesboolean
credentialstring nullable
enabledboolean
mode'block' | 'monitor'
on_unavailable'block' | 'monitor'
profilestring
urlstring nullable
validate_kwargsobject nullable
workspace_idsstring[] nullable

Example request

{
  "credential": "sk-guardrails-...",
  "mode": "monitor",
  "url": "https://guardrails.internal.example/validate"
}

Response

Successful Response

applies_to_all_workspacesboolean required
created_atstring required
enabledboolean required
has_credentialboolean required
idstring uuid required
modestring required
on_unavailablestring required
organization_idstring uuid required
profilestring required
updated_atstring required
urlstring nullable required
validate_kwargsobject nullable required
workspace_idsstring[] required

Changes