Končne točke upravljanja
Te končne točke vam omogočajo programsko upravljanje API ključev, pravil obrazcev, pravil opozoril in drugih nastavitev. Vse končne točke upravljanja zahtevajo JWT avtentikacijo.
Base URL: https://api.silentshield.io
API ključi
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys | Seznam vseh API ključev za vaš račun. |
POST | /api/v1/keys | Ustvarjanje novega API ključa. |
GET | /api/v1/keys/{id} | Pridobitev podrobnosti za določen API ključ. |
PUT | /api/v1/keys/{id} | Posodobitev nastavitev API ključa. |
DELETE | /api/v1/keys/{id} | Izbris API ključa. To dejanje je nepreklicno. |
POST | /api/v1/keys/{id}/rotate | Rotacija API ključa. Stari ključ je takoj razveljavljen. |
Pravila obrazcev
| Method | Path | Description |
|---|---|---|
GET | /v1/form-rules | Branje aktivnih pravil obrazcev za ključ. To pot kliče pripomoček sam; je edina končna točka za pravila obrazcev. |
GET | /api/v1/keys/{id}/formrules/dryrun | Preizkus pravila na nazadnje zaznanih obrazcih, brez shranjevanja. |
Pravila obrazcev se urejajo na nadzorni plošči, ne prek API-ja — ustvarjanja, spreminjanja in brisanja tu namenoma ni.
Pravila opozoril
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/{id}/alerts | Seznam vseh pravil opozoril za API ključ. |
POST | /api/v1/keys/{id}/alerts | Ustvarjanje novega pravila opozorila. |
DELETE | /api/v1/keys/{id}/alerts/{alertId} | Izbris pravila opozorila. |