tool-settings

List Guardrail Profiles

Changed on

List the guardrail profiles this deployment's guardrails service has built.

What an organization guardrail's profile may name, with the validate_kwargs each one accepts, so the dashboard offers a picker and typed fields instead of a free-text box beside an unrendered dict. The profiles come from the service itself and the parameter schemas from the any_guardrail registry; neither is a list kept in this repository. See gateway.services.guardrail_catalog.

Reports available: false with a reason rather than an error when the service is unconfigured, unreachable, or older than its /profiles endpoint, because a guardrails outage must not also break the page that configures guardrails.

Read against guardrails_url, which is the deployment's own service. An entry that carries an endpoint of its own is not probed: that URL is caller-supplied and fetching it here would make this a way to have the gateway request an address of the caller's choosing.

Not on verify_catalog_reader, despite being a catalog read: that plane is the three deployment-describing reads a data-plane key may also make, and admitting a key here would let any workspace credential dial the deployment's guardrails service. This is a management read, so it takes the router's own gate.

get/api/v1/tool-settings/guardrails/profiles

Request

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

Response

Successful Response

availableboolean required

Whether the guardrails service answered with its profiles

reasonstring nullable

Why the catalog is unavailable, in terms a tenant can act on

Changes

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status