Krajnje točke upravljanja

Ove krajnje točke omogućuju programsko upravljanje API ključevima, pravilima obrazaca, pravilima upozorenja i drugim postavkama. Sve krajnje točke upravljanja zahtijevaju JWT autentifikaciju.

Base URL: https://api.silentshield.io

API ključevi

MethodPathDescription
GET/api/v1/keysPopis svih API ključeva za vaš račun.
POST/api/v1/keysStvaranje novog API ključa.
GET/api/v1/keys/{id}Dobivanje detalja za određeni API ključ.
PUT/api/v1/keys/{id}Ažuriranje postavki API ključa.
DELETE/api/v1/keys/{id}Brisanje API ključa. Ova radnja je nepovratna.
POST/api/v1/keys/{id}/rotateRotacija API ključa. Stari ključ se odmah poništava.

Pravila obrazaca

MethodPathDescription
GET/v1/form-rulesČitanje aktivnih pravila obrazaca za ključ. Ovu rutu poziva sam widget; to je jedina krajnja točka za pravila obrazaca.
GET/api/v1/keys/{id}/formrules/dryrunIsprobavanje pravila na posljednje otkrivenim obrascima, bez spremanja.

Pravila obrazaca uređuju se na nadzornoj ploči, ne preko API-ja — stvaranje, izmjena i brisanje ovdje namjerno ne postoje.

Pravila upozorenja

MethodPathDescription
GET/api/v1/keys/{id}/alertsPopis svih pravila upozorenja za API ključ.
POST/api/v1/keys/{id}/alertsStvaranje novog pravila upozorenja.
DELETE/api/v1/keys/{id}/alerts/{alertId}Brisanje pravila upozorenja.