Modify Guardrail

Update an existing guardrail

PATCH /guardrails/modify-guardrail

Update Guardrail

cURL

curl --request PATCH \
  --url https://api.enkryptai.com/guardrails/modify-guardrail \
  --header 'Content-Type: application/json' \
  --header 'X-Enkrypt-Guardrail: <x-enkrypt-guardrail>' \
  --header 'apikey: <api-key>' \
  --data '
{
  "name": "My Guardrail",
  "description": "Guardrail for production chatbot",
  "input": {},
  "output": {}
}
'

200

{
  "message": "Guardrail details updated successfully"
}

Authorizations

apikey · string · header · required

Headers

X-Enkrypt-Guardrail · string · required

The guardrail name

Example:

"My Guardrail"

Body

application/json

name · string · required

The guardrail name

Example:

"My Guardrail"

description · string

Optional description of the guardrail

Example:

"Guardrail for production chatbot"

input · GuardrailsDetectorsObject · object

Detector configuration applied to input/prompt text

Show child attributes

output · GuardrailsDetectorsObject · object

Detector configuration applied to output/response text

Show child attributes

Response

200 - application/json

Successful Response

message · string

Example:

"Guardrail details updated successfully"

data · GuardrailResponseObject · object

Show child attributes