Skip to main content
PATCH
/
v2
/
guardrail-rules
/
{guardrail_rule_id}
Update guardrail rule
curl --request PATCH \
  --url https://api.orq.ai/v2/guardrail-rules/{guardrail_rule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "display_name": "<string>",
  "enabled": true,
  "guardrails": [
    {
      "id": "<string>",
      "is_guardrail": true,
      "options": {},
      "sample_rate": 0.5
    }
  ],
  "timeout": 1001
}
'
{
  "_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by_id": "<string>",
  "display_name": "<string>",
  "enabled": true,
  "project_id": "<string>",
  "timeout": 1001,
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by_id": "<string>",
  "description": "<string>",
  "expression": {
    "cel": "<string>",
    "config": {}
  },
  "guardrails": [
    {
      "id": "<string>",
      "is_guardrail": true,
      "options": {},
      "sample_rate": 0.5
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
guardrail_rule_id
string
required

The ID of the guardrail rule

Body

application/json
​
description
string
Maximum string length: 2048
​
display_name
string
Required string length: 1 - 256
​
enabled
boolean
​
expression
object
​
guardrails
object[]
​
timeout
integer<int64>
Required range: x >= 1000

Response

Guardrail rule updated successfully

​
_id
string
required
​
created_at
string<date-time>
required
​
created_by_id
string
required
​
display_name
string
required
Required string length: 1 - 256
​
enabled
boolean
required
​
project_id
string
required
​
timeout
integer<int64>
required
Required range: x >= 1000
​
updated_at
string<date-time>
required
​
updated_by_id
string
required
​
description
string
Maximum string length: 2048
​
expression
object
​
guardrails
object[] | null