Update Guardrails

PUT

/api/v2/guardrails/{guardrail_id}

Update the details of an existing guardrail using its unique guardrail ID.

PUT Parameters:

guardrail_id (int): ID of the guardrail to update

Returns:

JSON response containing the updated guardrail data

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT 'https:///api/v2/guardrails/' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Updated Guardrail Name",
    "description": "Updated guardrail description",
    "is_enabled": true
}'

Response Example

200 - Update Guardrail Response

{
    "success": true,
    "message": "Guardrail updated successfully",
    "data": {
        "id": 1,
        "name": "Updated Guardrail Name",
        "description": "Updated guardrail description",
        "guardrail_type": "topic_control",
        "is_enabled": true,
        "organization_id": 1
    }
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Get Guardrails

Delete Guardrails