Management Endpoints
These endpoints allow you to manage API keys, form rules, alert rules, and other settings programmatically. All management endpoints require JWT authentication.
Base URL: https://api.silentshield.io
API Keys
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys | List all API keys for your account. |
POST | /api/v1/keys | Create a new API key. |
GET | /api/v1/keys/{id} | Get details for a specific API key. |
PUT | /api/v1/keys/{id} | Update an API key's settings. |
DELETE | /api/v1/keys/{id} | Delete an API key. This action is irreversible. |
POST | /api/v1/keys/{id}/rotate | Rotate an API key. The old key is immediately invalidated. |
Form Rules
| Method | Path | Description |
|---|---|---|
GET | /v1/form-rules | Read the active form rules for a key. The widget itself calls this route; it is the API’s only form-rule endpoint. |
GET | /api/v1/keys/{id}/formrules/dryrun | Run a rule against the most recently detected forms without saving it. |
Form rules are maintained in the dashboard, not through the API — there is deliberately no create, update or delete here.
Alert Rules
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/{id}/alerts | List all alert rules for an API key. |
POST | /api/v1/keys/{id}/alerts | Create a new alert rule. |
DELETE | /api/v1/keys/{id}/alerts/{alertId} | Delete an alert rule. |