Create a Firewall Policy

POST

ai-gateway

firewall-policies

Create a prompt-firewall policy

curl --request POST \
  --url https://api.knoxcall.com/v1/ai-gateway/firewall-policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "heuristics": [
    {
      "name": "no_competitor_mentions",
      "pattern": "CompetitorAI",
      "flags": "i"
    }
  ],
  "canary_enabled": true,
  "action": "warn"
}
'

import requests

url = "https://api.knoxcall.com/v1/ai-gateway/firewall-policies"

payload = {
    "name": "<string>",
    "heuristics": [
        {
            "name": "no_competitor_mentions",
            "pattern": "CompetitorAI",
            "flags": "i"
        }
    ],
    "canary_enabled": True,
    "action": "warn"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    heuristics: [{name: 'no_competitor_mentions', pattern: 'CompetitorAI', flags: 'i'}],
    canary_enabled: true,
    action: 'warn'
  })
};

fetch('https://api.knoxcall.com/v1/ai-gateway/firewall-policies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.knoxcall.com/v1/ai-gateway/firewall-policies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'heuristics' => [
        [
                'name' => 'no_competitor_mentions',
                'pattern' => 'CompetitorAI',
                'flags' => 'i'
        ]
    ],
    'canary_enabled' => true,
    'action' => 'warn'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.knoxcall.com/v1/ai-gateway/firewall-policies"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"heuristics\": [\n    {\n      \"name\": \"no_competitor_mentions\",\n      \"pattern\": \"CompetitorAI\",\n      \"flags\": \"i\"\n    }\n  ],\n  \"canary_enabled\": true,\n  \"action\": \"warn\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.knoxcall.com/v1/ai-gateway/firewall-policies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"heuristics\": [\n    {\n      \"name\": \"no_competitor_mentions\",\n      \"pattern\": \"CompetitorAI\",\n      \"flags\": \"i\"\n    }\n  ],\n  \"canary_enabled\": true,\n  \"action\": \"warn\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.knoxcall.com/v1/ai-gateway/firewall-policies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"heuristics\": [\n    {\n      \"name\": \"no_competitor_mentions\",\n      \"pattern\": \"CompetitorAI\",\n      \"flags\": \"i\"\n    }\n  ],\n  \"canary_enabled\": true,\n  \"action\": \"warn\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "version": 123,
    "heuristics": [
      {
        "name": "no_competitor_mentions",
        "kind": "regex",
        "pattern": "CompetitorAI",
        "flags": "i"
      }
    ],
    "canary_enabled": true,
    "action": "block",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Creates a policy. action is what makes this endpoint matter:

`action`	What a match does
`block`	The request is refused with `400 firewall_block` and never reaches the provider.
`warn`	The request proceeds; the match is recorded.
`tag`	The request proceeds; the match is recorded as `tag`.

With no policy attached to an agent, the outcome is warn and block is unreachable. Creating a policy with action: "block" and setting the agent’s firewall_policy_id is what turns detection into refusal. Every regex rule is compiled through a safe-regex validator at write time, so a pattern that could backtrack catastrophically is refused here rather than discovered on the hot path. Dry-run a rule set first with Test firewall rules — the tester compiles through the same validator, so a pattern it accepts can actually run. Requires the create capability on ai_gateway. See the control-plane overview for authentication, the {data, meta} envelope, pagination and error types.

Authorizations

Authorization

string

header

required

OAuth 2.1 authentication — recommended for new integrations. Access tokens (kc_ prefix) are minted at the root-host token endpoint https://api.knoxcall.com/oauth/token and passed as Authorization: Bearer <access_token>. Public clients must use PKCE with the authorization_code grant; confidential clients may use client_credentials. The first-party SDKs and the knoxcall login CLI handle token minting, caching, refresh, and DPoP for you.

Body

application/json

name

string

required

2-64 chars. Re-using an existing name creates the next version.

heuristics

object[]

Show child attributes

canary_enabled

boolean

default:true

action

enum<string>

default:warn

Available options:

block,

warn,

tag

Response

The created policy.

data

object

A tenant-scoped prompt-firewall policy, attachable to agents and MCP servers.

Show child attributes

meta

object

Metadata included with every API response.

Show child attributes

Create a prompt-firewall policy

curl --request POST \
  --url https://api.knoxcall.com/v1/ai-gateway/firewall-policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "heuristics": [
    {
      "name": "no_competitor_mentions",
      "pattern": "CompetitorAI",
      "flags": "i"
    }
  ],
  "canary_enabled": true,
  "action": "warn"
}
'

import requests

url = "https://api.knoxcall.com/v1/ai-gateway/firewall-policies"

payload = {
    "name": "<string>",
    "heuristics": [
        {
            "name": "no_competitor_mentions",
            "pattern": "CompetitorAI",
            "flags": "i"
        }
    ],
    "canary_enabled": True,
    "action": "warn"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    heuristics: [{name: 'no_competitor_mentions', pattern: 'CompetitorAI', flags: 'i'}],
    canary_enabled: true,
    action: 'warn'
  })
};

fetch('https://api.knoxcall.com/v1/ai-gateway/firewall-policies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.knoxcall.com/v1/ai-gateway/firewall-policies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'heuristics' => [
        [
                'name' => 'no_competitor_mentions',
                'pattern' => 'CompetitorAI',
                'flags' => 'i'
        ]
    ],
    'canary_enabled' => true,
    'action' => 'warn'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.knoxcall.com/v1/ai-gateway/firewall-policies"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"heuristics\": [\n    {\n      \"name\": \"no_competitor_mentions\",\n      \"pattern\": \"CompetitorAI\",\n      \"flags\": \"i\"\n    }\n  ],\n  \"canary_enabled\": true,\n  \"action\": \"warn\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.knoxcall.com/v1/ai-gateway/firewall-policies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"heuristics\": [\n    {\n      \"name\": \"no_competitor_mentions\",\n      \"pattern\": \"CompetitorAI\",\n      \"flags\": \"i\"\n    }\n  ],\n  \"canary_enabled\": true,\n  \"action\": \"warn\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.knoxcall.com/v1/ai-gateway/firewall-policies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"heuristics\": [\n    {\n      \"name\": \"no_competitor_mentions\",\n      \"pattern\": \"CompetitorAI\",\n      \"flags\": \"i\"\n    }\n  ],\n  \"canary_enabled\": true,\n  \"action\": \"warn\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "version": 123,
    "heuristics": [
      {
        "name": "no_competitor_mentions",
        "kind": "regex",
        "pattern": "CompetitorAI",
        "flags": "i"
      }
    ],
    "canary_enabled": true,
    "action": "block",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Overview

Routes

Secrets

Clients

Environments

API Keys

Webhooks

Ephemeral Proxy

AI Gateway

Audit Logs

Account

Tenant KMS

Secret Store Migrations

Changelog

Create a Firewall Policy

Authorizations

Body

Response