Pārvaldības galapunkti
Šie galapunkti ļauj programmatiski pārvaldīt API atslēgas, formu noteikumus, brīdinājumu noteikumus un citus iestatījumus. Visiem pārvaldības galapunktiem nepieciešama JWT autentifikācija.
Base URL: https://api.silentshield.io
API atslēgas
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys | Sarakstīt visas jūsu konta API atslēgas. |
POST | /api/v1/keys | Izveidot jaunu API atslēgu. |
GET | /api/v1/keys/{id} | Iegūt informāciju par konkrētu API atslēgu. |
PUT | /api/v1/keys/{id} | Atjaunināt API atslēgas iestatījumus. |
DELETE | /api/v1/keys/{id} | Dzēst API atslēgu. Šī darbība ir neatgriezeniska. |
POST | /api/v1/keys/{id}/rotate | Rotēt API atslēgu. Vecā atslēga tiek nekavējoties anulēta. |
Formu noteikumi
| Method | Path | Description |
|---|---|---|
GET | /v1/form-rules | Nolasīt atslēgas aktīvos veidlapu noteikumus. Šo maršrutu izsauc pats logrīks; tas ir vienīgais veidlapu noteikumu galapunkts. |
GET | /api/v1/keys/{id}/formrules/dryrun | Izmēģināt noteikumu pret pēdējām atklātajām veidlapām, to nesaglabājot. |
Veidlapu noteikumus pārvalda vadības panelī, nevis caur API — izveide, maiņa un dzēšana šeit apzināti nav pieejamas.
Brīdinājumu noteikumi
| Method | Path | Description |
|---|---|---|
GET | /api/v1/keys/{id}/alerts | Sarakstīt visus API atslēgas brīdinājumu noteikumus. |
POST | /api/v1/keys/{id}/alerts | Izveidot jaunu brīdinājuma noteikumu. |
DELETE | /api/v1/keys/{id}/alerts/{alertId} | Dzēst brīdinājuma noteikumu. |