Guardrail

Get a workspace's agent guardrails

Changed on

Returns the workspace's guardrail rules with everything needed to render and edit them: the catalog of actions and groups a rule may target, the guardrails mabl applies to each agent type (read-only), and whether the workspace enforces guardrails. The response carries the rules' revision in its body and in the ETag and x-mabl-entity-version headers; send it back as If-Match when replacing the rules. Readable by any member of the workspace and by mabl global admins.

get/workspaces/{workspace_id}/guardrails

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/workspaces/{workspace_id}/guardrails
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

workspace_idstring required

The id of the workspace whose guardrails are returned.

Response

The workspace's guardrail rules, the catalog, the agent type ceilings and the enforcement state.

workspace_idstring

The id of the workspace the guardrails belong to.

revisioninteger

The revision of the workspace's rules, 0 before they were first saved; send it as If-Match to replace them.

mode'ENFORCE' | 'PREVIEW'

Whether a rule set's effects reach agents. ENFORCE applies every rule in the set wherever the workspace enforces guardrails; PREVIEW evaluates and logs every rule without ever changing what the agent gets.

enforcement_enabledboolean

Whether this workspace enforces guardrails. When false, a refusal is only logged and the agent request goes on.

Changes

  • b602223aa51fRevision changes
    • info

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

    • info

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

    • info

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

  • 91ff383fb7f9Revision changes
    • warning

      added the new external_agent enum value to the ////// response property for the response status