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": {}
}
'{
"message": "Guardrail details updated successfully",
"data": {
"name": "My Guardrail",
"description": "Guardrail for production chatbot",
"input": {
"topic_detector": {
"enabled": true,
"topic": [
"<string>"
],
"block_message": "<string>"
},
"nsfw": {
"enabled": true,
"block_message": "<string>"
},
"toxicity": {
"enabled": true,
"block_message": "<string>"
},
"pii": {
"enabled": true,
"entities": [
"pii"
]
},
"injection_attack": {
"enabled": true,
"block_message": "<string>"
},
"keyword_detector": {
"enabled": true,
"banned_keywords": [
"<string>"
]
},
"system_prompt": {
"enabled": false,
"index": "system",
"block_message": "<string>"
},
"copyright_ip": {
"enabled": false,
"block_message": "<string>"
},
"policy_violation": {
"enabled": true,
"policy_text": "<string>",
"coc_policy_name": "<string>",
"need_explanation": true,
"block_message": "<string>"
},
"bias": {
"enabled": true
},
"sponge_attack": {
"enabled": false,
"block_message": "<string>"
}
},
"output": {
"topic_detector": {
"enabled": true,
"topic": [
"<string>"
],
"block_message": "<string>"
},
"nsfw": {
"enabled": true,
"block_message": "<string>"
},
"toxicity": {
"enabled": true,
"block_message": "<string>"
},
"pii": {
"enabled": true,
"entities": [
"pii"
]
},
"injection_attack": {
"enabled": true,
"block_message": "<string>"
},
"keyword_detector": {
"enabled": true,
"banned_keywords": [
"<string>"
]
},
"system_prompt": {
"enabled": false,
"index": "system",
"block_message": "<string>"
},
"copyright_ip": {
"enabled": false,
"block_message": "<string>"
},
"policy_violation": {
"enabled": true,
"policy_text": "<string>",
"coc_policy_name": "<string>",
"need_explanation": true,
"block_message": "<string>"
},
"bias": {
"enabled": true
},
"sponge_attack": {
"enabled": false,
"block_message": "<string>"
}
},
"created_at": "2025-03-01T11:23:03.695943+00:00",
"updated_at": "2025-03-01T11:23:03.695943+00:00",
"policy_id": 1234567890,
"project_name": "default",
"created_by": "user@example.com",
"updated_by": "user@example.com",
"is_sample": false
}
}Update an existing guardrail
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": {}
}
'{
"message": "Guardrail details updated successfully",
"data": {
"name": "My Guardrail",
"description": "Guardrail for production chatbot",
"input": {
"topic_detector": {
"enabled": true,
"topic": [
"<string>"
],
"block_message": "<string>"
},
"nsfw": {
"enabled": true,
"block_message": "<string>"
},
"toxicity": {
"enabled": true,
"block_message": "<string>"
},
"pii": {
"enabled": true,
"entities": [
"pii"
]
},
"injection_attack": {
"enabled": true,
"block_message": "<string>"
},
"keyword_detector": {
"enabled": true,
"banned_keywords": [
"<string>"
]
},
"system_prompt": {
"enabled": false,
"index": "system",
"block_message": "<string>"
},
"copyright_ip": {
"enabled": false,
"block_message": "<string>"
},
"policy_violation": {
"enabled": true,
"policy_text": "<string>",
"coc_policy_name": "<string>",
"need_explanation": true,
"block_message": "<string>"
},
"bias": {
"enabled": true
},
"sponge_attack": {
"enabled": false,
"block_message": "<string>"
}
},
"output": {
"topic_detector": {
"enabled": true,
"topic": [
"<string>"
],
"block_message": "<string>"
},
"nsfw": {
"enabled": true,
"block_message": "<string>"
},
"toxicity": {
"enabled": true,
"block_message": "<string>"
},
"pii": {
"enabled": true,
"entities": [
"pii"
]
},
"injection_attack": {
"enabled": true,
"block_message": "<string>"
},
"keyword_detector": {
"enabled": true,
"banned_keywords": [
"<string>"
]
},
"system_prompt": {
"enabled": false,
"index": "system",
"block_message": "<string>"
},
"copyright_ip": {
"enabled": false,
"block_message": "<string>"
},
"policy_violation": {
"enabled": true,
"policy_text": "<string>",
"coc_policy_name": "<string>",
"need_explanation": true,
"block_message": "<string>"
},
"bias": {
"enabled": true
},
"sponge_attack": {
"enabled": false,
"block_message": "<string>"
}
},
"created_at": "2025-03-01T11:23:03.695943+00:00",
"updated_at": "2025-03-01T11:23:03.695943+00:00",
"policy_id": 1234567890,
"project_name": "default",
"created_by": "user@example.com",
"updated_by": "user@example.com",
"is_sample": false
}
}Documentation Index
Fetch the complete documentation index at: https://docs.enkryptai.com/llms.txt
Use this file to discover all available pages before exploring further.
The guardrail name
"My Guardrail"
The guardrail name
"My Guardrail"
Optional description of the guardrail
"Guardrail for production chatbot"
Detector configuration applied to input/prompt text
Show child attributes
Detector configuration applied to output/response text
Show child attributes