List guardrails

GET/v1/guardrails

List guardrails.

Returns a page of the organization's guardrails, without their checks. With workspace_id the list holds that workspace's guardrails and needs membership of the workspace; without it the list covers the whole organization and needs an organization admin.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Query parameters

organizationstringrequired
slug of the organization
workspace_idstring<uuid>
id (UUID) of a workspace, to list only its guardrails
enabledboolean
not applied at present: guardrails are listed whether enabled or not
searchstring
only guardrails whose name contains this text (case-sensitive)
pageinteger<int32>
page number, from 1. Default 1
page_sizeinteger<int32>
guardrails per page. Default 20, at most 100

Responses

200application/json

dataobject[]
The guardrails on this page.
Child attributes
- idstring<uuid>
  The guardrail's unique id (UUID).
- slugstring
  The guardrail's identifier in URLs, on virtual keys and in the x-guardrail header: gr- and 16 hex characters. It never changes.
- namestring
  Display name, unique within the organization.
- descriptionstring
  Free-text description. Null when none is set.
- organizationstring
  Slug of the organization that owns the guardrail.
- workspace_idstring<uuid>
  Id (UUID) of the workspace the guardrail belongs to.
- enabledboolean
  Whether the guardrail runs. A disabled guardrail is skipped wherever it is applied.
- check_countinteger<int32>
  How many checks the guardrail has.
- attached_key_countinteger<int32>
  How many virtual keys apply this guardrail.
- created_atstring<date-time>
  When the guardrail was created (ISO 8601).
- updated_atstring<date-time>
  When the guardrail was last changed (ISO 8601).
pageinteger<int32>
The page number, from 1.
page_sizeinteger<int32>
Guardrails per page.
totalinteger<int64>
Number of guardrails matching the filters.

VectorAxis is built by GK Labs, a member of NVIDIA Inception.