Hanteringsslutpunkter

Dessa slutpunkter låter dig hantera API-nycklar, formulärregler, varningsregler och andra inställningar programmatiskt. Alla hanteringsslutpunkter kräver JWT-autentisering.

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

API-nycklar

MethodPathDescription
GET/api/v1/keysLista alla API-nycklar för ditt konto.
POST/api/v1/keysSkapa en ny API-nyckel.
GET/api/v1/keys/{id}Hämta detaljer för en specifik API-nyckel.
PUT/api/v1/keys/{id}Uppdatera en API-nyckels inställningar.
DELETE/api/v1/keys/{id}Ta bort en API-nyckel. Denna åtgärd är oåterkallelig.
POST/api/v1/keys/{id}/rotateRotera en API-nyckel. Den gamla nyckeln ogiltigförklaras omedelbart.

Formulärregler

MethodPathDescription
GET/v1/form-rulesLäs de aktiva formulärreglerna för en nyckel. Widgeten anropar själv den här rutten; det är API:ets enda slutpunkt för formulärregler.
GET/api/v1/keys/{id}/formrules/dryrunProva en regel mot de senast upptäckta formulären utan att spara den.

Formulärregler hanteras i instrumentpanelen, inte via API:et — skapa, ändra och ta bort finns medvetet inte här.

Varningsregler

MethodPathDescription
GET/api/v1/keys/{id}/alertsLista alla varningsregler för en API-nyckel.
POST/api/v1/keys/{id}/alertsSkapa en ny varningsregel.
DELETE/api/v1/keys/{id}/alerts/{alertId}Ta bort en varningsregel.