Skip to content
POST/api/v1/firewall/rules

Create or update a firewall rule

Authentication

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

Request body required

Example

{
  "projectId": "00000000-0000-0000-0000-000000000000",
  "rule": {
    "id": "string",
    "name": "string",
    "type": "string",
    "condition": {},
    "action": {},
    "priority": 0,
    "enabled": false,
    "description": "string",
    "tags": [
      "string"
    ],
    "regions": [
      "string"
    ]
  }
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "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)$"
        },
        "rule": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "maxLength": 200
            },
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            },
            "type": {
              "type": "string",
              "minLength": 1,
              "maxLength": 60
            },
            "condition": {
              "type": "object",
              "additionalProperties": {}
            },
            "action": {
              "type": "object",
              "additionalProperties": {}
            },
            "priority": {
              "type": "integer",
              "minimum": 0,
              "maximum": 10000
            },
            "enabled": {
              "type": "boolean"
            },
            "description": {
              "type": "string",
              "maxLength": 2000
            },
            "tags": {
              "maxItems": 50,
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 60
              }
            },
            "regions": {
              "maxItems": 50,
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "name",
            "type",
            "condition",
            "action"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "projectId",
        "rule"
      ],
      "additionalProperties": false
    }
  }
}

Response

All status codes

201Rule saved
400Bad Request — DETECTOR_CONTRACT_VIOLATION, UNSAFE_REGEX.
401Unauthorized — no valid credential was presented (AUTH_REQUIRED).
403Forbidden — CROSS_PROJECT_DENIED.
409Conflict — RULE_LIMIT_REACHED.
429Too Many Requests — the per-key or per-organization rate limit was exceeded. Honour the Retry-After header.
500Internal Server Error.
503Service Unavailable — OWNERSHIP_CHECK_FAILED, RULE_LIMIT_CHECK_FAILED.

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/firewall/rules \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "projectId": "00000000-0000-0000-0000-000000000000", "rule": { "id": "string", "name": "string", "type": "string", "condition": {}, "action": {}, "priority": 0, "enabled": false, "description": "string", "tags": [ "string" ], "regions": [ "string" ] } }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/firewall/rules", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "projectId": "00000000-0000-0000-0000-000000000000",
    "rule": {
      "id": "string",
      "name": "string",
      "type": "string",
      "condition": {},
      "action": {},
      "priority": 0,
      "enabled": false,
      "description": "string",
      "tags": [
        "string"
      ],
      "regions": [
        "string"
      ]
    }
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/firewall/rules",
    headers=headers,
    json={
    "projectId": "00000000-0000-0000-0000-000000000000",
    "rule": {
        "id": "string",
        "name": "string",
        "type": "string",
        "condition": {},
        "action": {},
        "priority": 0,
        "enabled": False,
        "description": "string",
        "tags": [
            "string"
        ],
        "regions": [
            "string"
        ]
    }
},
)
print(response.status_code, response.json())

Go

package main

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

func main() {
	body := strings.NewReader(`{"projectId":"00000000-0000-0000-0000-000000000000","rule":{"id":"string","name":"string","type":"string","condition":{},"action":{},"priority":0,"enabled":false,"description":"string","tags":["string"],"regions":["string"]}}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/firewall/rules", 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

400401403409429500503

Other Firewall endpoints