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 | /api/v1/keys/:keyId/form-rules | List all form rules for an API key. |
POST | /api/v1/keys/:keyId/form-rules | Create a new form rule. |
PUT | /api/v1/keys/:keyId/form-rules/:id | Update a form rule. |
DELETE | /api/v1/keys/:keyId/form-rules/:id | Delete a form rule. |
Alert Rules
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/:keyId/alert-rules | List all alert rules for an API key. |
POST | /api/v1/keys/:keyId/alert-rules | Create a new alert rule. |
PUT | /api/v1/keys/:keyId/alert-rules/:id | Update an alert rule. |
DELETE | /api/v1/keys/:keyId/alert-rules/:id | Delete an alert rule. |