Update Firewall Rule

Update Firewall Rule

Updates an existing firewall rule. All fields are optional - only provide the fields you want to change.

Paid Plans Only

This endpoint requires a paid plan. Free plan users will receive a 403 Forbidden error.

Endpoint

PATCH /v1/firewall-rules/{id}

Path Parameters

Parameter	Type	Required	Description
id	integer	Yes	The firewall rule ID

Request Body

All fields are optional. Only include fields you want to update:

Parameter	Type	Description
name	string	Rule name (max 128 characters)
is_enabled	boolean	Whether rule is active
priority	integer	Rule priority (-1000 to 1000)
scope	string	prompt or response
type	string	substring or regex
pattern	string	Pattern to match
action	string	block, mask, or warn
replacement	string	Replacement text for mask action

Examples

Example 1: Enable/Disable Rule

TypeScript

import Tokenrouter from 'tokenrouter';

const client = new Tokenrouter({
  apiKey: process.env.TOKENROUTER_API_KEY
});

// Disable a rule
await client.firewallRules.update(123, {
  is_enabled: false
});

// Enable a rule
await client.firewallRules.update(123, {
  is_enabled: true
});

Python

from tokenrouter import Tokenrouter

client = Tokenrouter(
    api_key=os.getenv("TOKENROUTER_API_KEY")
)

# Disable a rule
client.firewall_rules.update(123, is_enabled=False)

# Enable a rule
client.firewall_rules.update(123, is_enabled=True)

cURL

# Disable a rule
curl -X PATCH https://api.tokenrouter.io/v1/firewall-rules/123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tr_..." \
  -d '{"is_enabled": false}'

Example 2: Change Priority

TypeScript

// Increase priority to make rule execute earlier
await client.firewallRules.update(123, {
  priority: 200
});

// Decrease priority
await client.firewallRules.update(123, {
  priority: 50
});

Python

# Increase priority to make rule execute earlier
client.firewall_rules.update(123, priority=200)

# Decrease priority
client.firewall_rules.update(123, priority=50)

cURL

curl -X PATCH https://api.tokenrouter.io/v1/firewall-rules/123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tr_..." \
  -d '{"priority": 200}'

Example 3: Update Pattern

TypeScript

// Update pattern to be more specific
await client.firewallRules.update(123, {
  pattern: '\\d{4}-\\d{4}-\\d{4}-\\d{4}'  // More specific credit card format
});

Python

# Update pattern to be more specific
client.firewall_rules.update(
    123,
    pattern=r"\d{4}-\d{4}-\d{4}-\d{4}"  # More specific credit card format
)

cURL

curl -X PATCH https://api.tokenrouter.io/v1/firewall-rules/123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tr_..." \
  -d '{"pattern": "\\d{4}-\\d{4}-\\d{4}-\\d{4}"}'

Example 4: Change Action from Block to Mask

TypeScript

// Change from blocking to masking
await client.firewallRules.update(123, {
  action: 'mask',
  replacement: '[SENSITIVE_DATA_REDACTED]'
});

Python

# Change from blocking to masking
client.firewall_rules.update(
    123,
    action="mask",
    replacement="[SENSITIVE_DATA_REDACTED]"
)

cURL

curl -X PATCH https://api.tokenrouter.io/v1/firewall-rules/123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tr_..." \
  -d '{
    "action": "mask",
    "replacement": "[SENSITIVE_DATA_REDACTED]"
  }'

Example 5: Change Scope

TypeScript

// Move rule from prompt to response filtering
await client.firewallRules.update(123, {
  scope: 'response'
});

Python

# Move rule from prompt to response filtering
client.firewall_rules.update(123, scope="response")

cURL

curl -X PATCH https://api.tokenrouter.io/v1/firewall-rules/123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tr_..." \
  -d '{"scope": "response"}'

Example 6: Update Multiple Fields

TypeScript

await client.firewallRules.update(123, {
  name: 'Updated Rule Name',
  priority: 150,
  is_enabled: true,
  pattern: 'new-pattern',
  action: 'warn'
});

Python

client.firewall_rules.update(
    123,
    name="Updated Rule Name",
    priority=150,
    is_enabled=True,
    pattern="new-pattern",
    action="warn"
)

cURL

curl -X PATCH https://api.tokenrouter.io/v1/firewall-rules/123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer tr_..." \
  -d '{
    "name": "Updated Rule Name",
    "priority": 150,
    "is_enabled": true,
    "pattern": "new-pattern",
    "action": "warn"
  }'

Response

{
  "data": {
    "id": 123,
    "user_id": 456,
    "name": "Updated Rule Name",
    "is_enabled": true,
    "priority": 150,
    "scope": "prompt",
    "type": "regex",
    "pattern": "new-pattern",
    "action": "warn",
    "replacement": null,
    "created_at": "2025-11-10T12:00:00Z",
    "updated_at": "2025-11-10T15:30:00Z"
  }
}

Error Responses

403 Forbidden - Free Plan

{
  "error": {
    "message": "Firewall rules are not available on the free plan",
    "type": "authorization_error",
    "http_status": 403
  }
}

404 Not Found

{
  "error": {
    "message": "Firewall rule not found",
    "type": "not_found_error",
    "http_status": 404
  }
}

422 Validation Error

{
  "error": {
    "message": "Validation failed",
    "type": "validation_error",
    "http_status": 422,
    "errors": {
      "priority": ["The priority must be between -1000 and 1000"],
      "scope": ["The scope must be either 'prompt' or 'response'"]
    }
  }
}

Practical Patterns

Temporarily Disable for Testing

TypeScript

// Disable temporarily
await client.firewallRules.update(ruleId, {
  is_enabled: false
});

// Test your requests...

// Re-enable
await client.firewallRules.update(ruleId, {
  is_enabled: true
});

Python

# Disable temporarily
client.firewall_rules.update(rule_id, is_enabled=False)

# Test your requests...

# Re-enable
client.firewall_rules.update(rule_id, is_enabled=True)

Adjust Priority Relative to Others

TypeScript

// Get all rules
const rules = await client.firewallRules.list();

// Find highest priority
const highestPriority = Math.max(...rules.data.map(r => r.priority));

// Make this rule highest priority
await client.firewallRules.update(ruleId, {
  priority: highestPriority + 10
});

Python

# Get all rules
rules = client.firewall_rules.list()

# Find highest priority
highest_priority = max(rule.priority for rule in rules.data)

# Make this rule highest priority
client.firewall_rules.update(rule_id, priority=highest_priority + 10)

Transition from Block to Warn

Gradually soften rule enforcement:

TypeScript

// Step 1: Change from block to warn (test phase)
await client.firewallRules.update(ruleId, {
  action: 'warn'
});

// Monitor warnings for a period...

// Step 2: If safe, disable entirely
await client.firewallRules.update(ruleId, {
  is_enabled: false
});

Python

# Step 1: Change from block to warn (test phase)
client.firewall_rules.update(rule_id, action="warn")

# Monitor warnings for a period...

# Step 2: If safe, disable entirely
client.firewall_rules.update(rule_id, is_enabled=False)

Update Replacement Text

TypeScript

// Make replacement text more specific
await client.firewallRules.update(maskRuleId, {
  replacement: '[PII_REDACTED_' + new Date().toISOString() + ']'
});

Python

from datetime import datetime

# Make replacement text more specific
client.firewall_rules.update(
    mask_rule_id,
    replacement=f"[PII_REDACTED_{datetime.now().isoformat()}]"
)

Best Practices

1. Update one field at a time when testing changes
2. Disable before major changes to prevent unexpected blocking
3. Test pattern changes carefully - invalid regex can cause errors
4. Document changes in your version control or change log
5. Use descriptive names when renaming rules
6. Monitor after updates - check logs for unexpected matches
7. Keep replacement text clear - describe what was masked

Bulk Updates

Update multiple rules with the same change:

TypeScript

// Disable all warn-action rules
const rules = await client.firewallRules.list();

const warnRules = rules.data.filter(r => r.action === 'warn');

for (const rule of warnRules) {
  await client.firewallRules.update(rule.id, {
    is_enabled: false
  });
  console.log(`Disabled: ${rule.name}`);
}

Python

# Disable all warn-action rules
rules = client.firewall_rules.list()

warn_rules = [r for r in rules.data if r.action == "warn"]

for rule in warn_rules:
    client.firewall_rules.update(rule.id, is_enabled=False)
    print(f"Disabled: {rule.name}")

Next Steps

• Delete Firewall Rule
• Get Firewall Rule
• List All Rules
• Create New Rule