Skip to navigation

Get guardrail policy by id

View as Markdown
Get guardrail policy by id

Path parameters

idstringRequiredformat: "uuid"

Response

Guardrail policy
namestring0-255 characters
The SDK names policies by name, so it is unique in the workspace, ignoring case
ruleslist of objects
At most one rule per type
idstringOptionalformat: "uuid"
Optional on create, generated when missing, as for prompts and datasets. Ignored on update, where the path names the policy
descriptionstringOptional0-1000 characters
execution_scopeenumOptionalDefaults to on_request

on_request applies the policy when the SDK names it, global applies it to every guardrail built from stored policies in the workspace. Missing or null means on_request

Allowed values:
created_atdatetimeOptionalRead-only
created_bystringOptionalRead-only
last_updated_atdatetimeOptionalRead-only
last_updated_bystringOptionalRead-only

Errors

403
Forbidden Error
404
Not Found Error
503
Service Unavailable Error