Get Guardrail By Id

Get guardrail by id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns one guardrail by its ID, including its current_version. Set with_deleted to true to return a deleted guardrail.

When to use it

Use it to read a guardrail's settings and the rules in its current version.

Required parameters

  • guardrail_id (path): the ID of the guardrail.

Optional query parameters: with_deleted.

Response

A successful call returns 200 OK with the GuardrailSchema object: id, name, description, observability_enabled, dataset_id, current_version, tags, and timestamps.

Related: List guardrails, Update a guardrail, List guardrail versions

Path Params
string
required
Query Params
boolean
Defaults to false

Include deleted guardrails

Responses

401

Unauthorized

404

Not Found

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json