Skip to content
POST/api/v1/gateway/guardrails

Create or update a guardrail config

Upserts a partner-guardrail vendor config (idempotent on project_id+vendor). camelCase body; the raw API key is NEVER accepted - secretRef points at a provider_keys row (required for non-local vendors, forbidden for local presets). admin role. Returns 201.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "orgId": "00000000-0000-0000-0000-000000000000",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "vendor": "lakera",
  "vendorChain": [
    "lakera"
  ],
  "fallbackOnErrors": [
    "string"
  ],
  "config": {},
  "secretRef": "00000000-0000-0000-0000-000000000000",
  "onFlag": "block",
  "checkRequest": false,
  "checkResponse": false,
  "tokenizePii": false,
  "enabled": false,
  "priority": 0
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "orgId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "projectId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "vendor": {
          "type": "string",
          "enum": [
            "lakera",
            "aporia",
            "patronus",
            "nemo",
            "pillar",
            "pinecone-guardrails",
            "promptfoo-cloud",
            "protect-ai",
            "robust-intelligence",
            "privera",
            "azure-content-safety",
            "llama-guard",
            "pangea",
            "enkrypt",
            "lasso",
            "hiddenlayer",
            "grayswan",
            "dynamoai",
            "crowdstrike",
            "watsonx",
            "zscaler",
            "bedrock-guardrails",
            "openai-moderation",
            "mistral-moderation",
            "local-firewall",
            "moderated-firewall"
          ],
          "description": "One of ALLOWED_GUARDRAIL_VENDORS (incl. local-firewall / moderated-firewall presets)."
        },
        "vendorChain": {
          "minItems": 1,
          "maxItems": 8,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "lakera",
              "aporia",
              "patronus",
              "nemo",
              "pillar",
              "pinecone-guardrails",
              "promptfoo-cloud",
              "protect-ai",
              "robust-intelligence",
              "privera",
              "azure-content-safety",
              "llama-guard",
              "pangea",
              "enkrypt",
              "lasso",
              "hiddenlayer",
              "grayswan",
              "dynamoai",
              "crowdstrike",
              "watsonx",
              "zscaler",
              "bedrock-guardrails",
              "openai-moderation",
              "mistral-moderation",
              "local-firewall",
              "moderated-firewall"
            ]
          }
        },
        "fallbackOnErrors": {
          "maxItems": 8,
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "config": {
          "type": "object",
          "additionalProperties": {},
          "description": "Non-secret vendor knobs only (endpoint/profile/baseUrl)."
        },
        "secretRef": {
          "nullable": true,
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
          "description": "Reference to a provider_keys row. Required for vendor adapters; must be omitted for local presets."
        },
        "onFlag": {
          "type": "string",
          "enum": [
            "block",
            "redact",
            "flag"
          ]
        },
        "checkRequest": {
          "type": "boolean"
        },
        "checkResponse": {
          "type": "boolean"
        },
        "tokenizePii": {
          "type": "boolean"
        },
        "enabled": {
          "type": "boolean"
        },
        "priority": {
          "type": "integer",
          "minimum": 0,
          "maximum": 10000
        }
      },
      "required": [
        "orgId",
        "projectId",
        "vendor"
      ],
      "additionalProperties": false
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Created.
400(no description)
401(no description)
403Forbidden - insufficient role for this operation.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/gateway/guardrails \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "projectId": "00000000-0000-0000-0000-000000000000", "vendor": "lakera", "vendorChain": [ "lakera" ], "fallbackOnErrors": [ "string" ], "config": {}, "secretRef": "00000000-0000-0000-0000-000000000000", "onFlag": "block", "checkRequest": false, "checkResponse": false, "tokenizePii": false, "enabled": false, "priority": 0 }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/gateway/guardrails",
  body: {
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "vendor": "lakera",
    "vendorChain": [
      "lakera"
    ],
    "fallbackOnErrors": [
      "string"
    ],
    "config": {},
    "secretRef": "00000000-0000-0000-0000-000000000000",
    "onFlag": "block",
    "checkRequest": false,
    "checkResponse": false,
    "tokenizePii": false,
    "enabled": false,
    "priority": 0
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/gateway/guardrails",
    body={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "vendor": "lakera",
    "vendorChain": [
        "lakera"
    ],
    "fallbackOnErrors": [
        "string"
    ],
    "config": {},
    "secretRef": "00000000-0000-0000-0000-000000000000",
    "onFlag": "block",
    "checkRequest": False,
    "checkResponse": False,
    "tokenizePii": False,
    "enabled": False,
    "priority": 0
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"orgId":"00000000-0000-0000-0000-000000000000","projectId":"00000000-0000-0000-0000-000000000000","vendor":"lakera","vendorChain":["lakera"],"fallbackOnErrors":["string"],"config":{},"secretRef":"00000000-0000-0000-0000-000000000000","onFlag":"block","checkRequest":false,"checkResponse":false,"tokenizePii":false,"enabled":false,"priority":0}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/gateway/guardrails", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429

Other Gateway endpoints