PATCH
/
v4
/
guardrails
/
{id}
curl --request PATCH \
  --url https://api.egp.scale.com/v4/guardrails/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "is_archived": true
}'
{
  "id": "<string>",
  "account_id": "<string>",
  "description": "<string>",
  "check_type": "input",
  "guardrail_metadata": {},
  "is_archived": true,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string | null

Path Parameters

​
id
string
required

Body

application/json
​
is_archived
boolean

Flag to indicate whether the guardrail is archived.

Response

200
application/json
Successful Response
​
id
string
required
​
account_id
string
required
​
check_type
enum<string>
required
Available options:
input,
output
​
created_at
string
required

The date and time when the entity was created in ISO format.

​
description
string
​
guardrail_metadata
object
​
is_archived
boolean
Get GuardrailList Attack Categories With Descriptions