Крайни точки за управление
Тези крайни точки ви позволяват да управлявате API ключове, правила за формуляри, правила за известия и други настройки програмно. Всички крайни точки за управление изискват JWT удостоверяване.
Base URL: https://api.silentshield.io
API ключове
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys | Списък на всички API ключове за вашия акаунт. |
POST | /api/v1/keys | Създаване на нов API ключ. |
GET | /api/v1/keys/{id} | Получаване на детайли за конкретен API ключ. |
PUT | /api/v1/keys/{id} | Актуализиране на настройките на API ключ. |
DELETE | /api/v1/keys/{id} | Изтриване на API ключ. Това действие е необратимо. |
POST | /api/v1/keys/{id}/rotate | Ротация на API ключ. Старият ключ се обезсилва незабавно. |
Правила за формуляри
| Method | Path | Description |
|---|---|---|
GET | /v1/form-rules | Прочитане на активните правила за формуляри за даден ключ. Уиджетът сам извиква този маршрут; това е единствената крайна точка за правила на формуляри. |
GET | /api/v1/keys/{id}/formrules/dryrun | Пробно прилагане на правило спрямо последно откритите формуляри, без да се записва. |
Правилата за формуляри се поддържат в таблото, не през API — създаване, промяна и изтриване тук съзнателно липсват.
Правила за известия
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/{id}/alerts | Списък на всички правила за известия за API ключ. |
POST | /api/v1/keys/{id}/alerts | Създаване на ново правило за известие. |
DELETE | /api/v1/keys/{id}/alerts/{alertId} | Изтриване на правило за известие. |