Skip to main content
PATCH
/
guardrails
/
modify-guardrail
Update 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": {
    "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>"
    }
  }
}
'
{
  "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
  }
}

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

output
GuardrailsDetectorsObject · object

Detector configuration applied to output/response text

Response

200 - application/json

Successful Response

message
string
Example:

"Guardrail details updated successfully"

data
GuardrailResponseObject · object