Skip to content

Delete Rule

Delete a rule using soft delete. Deleted rules are retained for historical activity analysis.

Endpoint

DELETE /api/rules/:id

Soft-deletes a rule. The rule is marked as deleted but retained in the database for historical activity queries.

Authentication

Requires API Key with Policy Definition permission.

Path Parameters

Parameter Type Description
id UUID Rule ID to delete

Response

Returns 204 No Content on successful deletion.

Examples

Delete Rule

Delete a rule by ID.

RULE_ID="rule-uuid-123"

curl -X DELETE "https://your-shield-host:8080/api/rules/$RULE_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

BASE_URL = "https://your-shield-host:8080"
HEADERS = {"Authorization": "Bearer YOUR_API_KEY"}

rule_id = "rule-uuid-123"

response = requests.delete(f"{BASE_URL}/api/rules/{rule_id}", headers=HEADERS)

if response.status_code == 204:
    print(f"Rule {rule_id} deleted successfully")

const axios = require('axios');

const BASE_URL = 'https://your-shield-host:8080';
const HEADERS = { 'Authorization': 'Bearer YOUR_API_KEY' };

const ruleId = 'rule-uuid-123';

const response = await axios.delete(`${BASE_URL}/api/rules/${ruleId}`, { headers: HEADERS });

if (response.status === 204) {
  console.log(`Rule ${ruleId} deleted successfully`);
}

Important Notes

Soft Delete Behavior

Deleted rules are retained in the database with a deleted flag. They:

  • Do not appear in GET /api/rules responses
  • Do appear in GET /api/rulesdeleted responses
  • Are still referenced in historical activity data
  • Cannot be undeleted through the API (requires database operation)

Impact on Activities

Deleting a rule does not delete historical activities where this rule was triggered. Activities retain the rule ID for historical analysis.

Impact on Rule Evaluation

Once deleted, the rule is immediately removed from rule evaluation. Future traffic will not be processed by this rule.

Error Responses

Status Code Description
401 Invalid or expired API key
403 Insufficient permissions (requires Policy Definition)
404 Rule not found