guardrails

Update Guardrail

Changed on

Update an existing guardrail

👉 Guardrail docs

Example Request:

curl -X PUT "http://localhost:4000/guardrails/123e4567-e89b-12d3-a456-426614174000" \
    -H "Authorization: Bearer <your_api_key>" \
    -H "Content-Type: application/json" \
    -d '{
        "guardrail": {
            "guardrail_name": "updated-bedrock-guard",
            "litellm_params": {
                "guardrail": "bedrock",
                "mode": "pre_call",
                "guardrailIdentifier": "ff6ujrregl1q",
                "guardrailVersion": "1.0",
                "default_on": true
            },
            "guardrail_info": {
                "description": "Updated Bedrock content moderation guardrail"
            }
        }
    }'

Example Response:

{
    "guardrail_id": "123e4567-e89b-12d3-a456-426614174000",
    "guardrail_name": "updated-bedrock-guard",
    "litellm_params": {
        "guardrail": "bedrock",
        "mode": "pre_call",
        "guardrailIdentifier": "ff6ujrregl1q",
        "guardrailVersion": "1.0",
        "default_on": true
    },
    "guardrail_info": {
        "description": "Updated Bedrock content moderation guardrail"
    },
    "created_at": "2023-11-09T12:34:56.789Z",
    "updated_at": "2023-11-09T13:45:12.345Z"
}
put/guardrails/{guardrail_id}

Request

Path parameters

guardrail_idstring required

Request body

Example request

{
  "guardrail": {
    "litellm_params": {
      "akto_base_url": "http://localhost:9090"
    }
  }
}

Response

Successful Response

unknown required

Changes

    • breaking

      removed from the // request property anyOf list

    • info

      api tag guardrails added

    • info

      api tag Guardrails removed

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added to the // request property anyOf list

    • info

      the request property default value v1 was removed

    • info

      added the new CA_SIN enum value to the request property /////

    • info

      added the new DE_BSNR enum value to the request property /////

    • info

      added the new DE_FUEHRERSCHEIN enum value to the request property /////

    • info

      added the new DE_HANDELSREGISTER enum value to the request property /////

    • info

      added the new DE_HEALTH_INSURANCE enum value to the request property /////

    • info

      added the new DE_ID_CARD enum value to the request property /////

    • info

      added the new DE_KFZ enum value to the request property /////

    • info

      added the new DE_LANR enum value to the request property /////

    • info

      added the new DE_PASSPORT enum value to the request property /////

    • info

      added the new DE_PLZ enum value to the request property /////

    • info

      added the new DE_SOCIAL_SECURITY enum value to the request property /////

    • info

      added the new DE_TAX_ID enum value to the request property /////

    • info

      added the new DE_TAX_NUMBER enum value to the request property /////

    • info

      added the new DE_VAT_ID enum value to the request property /////

    • info

      added the new ES_PASSPORT enum value to the request property /////

    • info

      added the new IN_GSTIN enum value to the request property /////

    • info

      added the new KR_BRN enum value to the request property /////

    • info

      added the new KR_DRIVER_LICENSE enum value to the request property /////

    • info

      added the new KR_FRN enum value to the request property /////

    • info

      added the new KR_PASSPORT enum value to the request property /////

    • info

      added the new KR_RRN enum value to the request property /////

    • info

      added the new MAC_ADDRESS enum value to the request property /////

    • info

      added the new NG_NIN enum value to the request property /////

    • info

      added the new NG_VEHICLE_REGISTRATION enum value to the request property /////

    • info

      added the new PH_PASSPORT enum value to the request property /////

    • info

      added the new PH_TIN enum value to the request property /////

    • info

      added the new PH_UMID enum value to the request property /////

    • info

      added the new SE_ORGANISATIONSNUMMER enum value to the request property /////

    • info

      added the new SE_PERSONNUMMER enum value to the request property /////

    • info

      added the new TH_TNIN enum value to the request property /////

    • info

      added the new TR_LICENSE_PLATE enum value to the request property /////

    • info

      added the new TR_NATIONAL_ID enum value to the request property /////

    • info

      added the new UK_DRIVING_LICENCE enum value to the request property /////

    • info

      added the new UK_PASSPORT enum value to the request property /////

    • info

      added the new UK_POSTCODE enum value to the request property /////

    • info

      added the new UK_VEHICLE_REGISTRATION enum value to the request property /////

    • info

      added the new US_MBI enum value to the request property /////

    • info

      added the new US_NPI enum value to the request property /////

    • info

      added the new UUID enum value to the request property /////

    • info

      added the new ZA_ID_NUMBER enum value to the request property /////

    • info

      added the new alert enum value to the request property ///

    • info

      added the new block enum value to the request property ///

    • info

      added the new inject_system_message enum value to the request property ///

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status