organization-guardrails

Update Organization Guardrail

Changed on

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/api/v1/organizations/me/guardrails/{guardrail_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

guardrail_idstring uuid required

Request body

applies_to_all_workspacesboolean
credentialstring nullable
definition_idstring uuid nullable

The organization's own definition this mandate runs. Unlike url and credential, an explicit null clears the link; omit the field to leave it as it is

enabledboolean
mode'block' | 'monitor'
on_unavailable'block' | 'monitor'
profilestring
urlstring nullable
validate_kwargsobject nullable

Replaces the stored kwargs whole. A parameter sent as *** keeps the value stored under that name, which is how a credential-shaped one survives an edit of the rest of the entry

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
definition_idstring uuid nullable 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

Extra kwargs for the check itself, sent to the guardrails service or handed to the guardrail this entry's definition builds. A parameter whose name looks credential-shaped comes back as *** rather than its stored value; sending that *** back keeps what is stored

workspace_idsstring[] required

Changes

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property

    • info

      added the required property to the response with the status