Halduse lõpp-punktid
Need lõpp-punktid võimaldavad teil hallata API-võtmeid, vormireegleid, teavitusreegleid ja muid seadeid programmiliselt. Kõik halduse lõpp-punktid nõuavad JWT autentimist.
Base URL: https://api.silentshield.io
API-võtmed
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys | Loetleb kõik teie konto API-võtmed. |
POST | /api/v1/keys | Loob uue API-võtme. |
GET | /api/v1/keys/{id} | Saab konkreetse API-võtme üksikasjad. |
PUT | /api/v1/keys/{id} | Värskendab API-võtme seadeid. |
DELETE | /api/v1/keys/{id} | Kustutab API-võtme. See toiming on pöördumatu. |
POST | /api/v1/keys/{id}/rotate | Vahetab API-võtme. Vana võti muudetakse kohe kehtetuks. |
Vormireeglid
| Method | Path | Description |
|---|---|---|
GET | /v1/form-rules | Loe võtme aktiivsed vormireeglid. Seda marsruuti kutsub vidin ise; see on API ainus vormireegli lõpp-punkt. |
GET | /api/v1/keys/{id}/formrules/dryrun | Katseta reeglit viimati tuvastatud vormide vastu ilma salvestamata. |
Vormireegleid hallatakse töölaual, mitte API kaudu — loomist, muutmist ja kustutamist siin teadlikult ei ole.
Teavitusreeglid
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/{id}/alerts | Loetleb kõik API-võtme teavitusreeglid. |
POST | /api/v1/keys/{id}/alerts | Loob uue teavitusreegli. |
DELETE | /api/v1/keys/{id}/alerts/{alertId} | Kustutab teavitusreegli. |