Endpoints tal-Ġestjoni

Dawn l-endpoints jippermettulek timmaniġġja ċwievet API, regoli tal-formoli, regoli tal-allerts, u settings oħra b'mod programmatiku. L-endpoints tal-ġestjoni kollha jeħtieġu awtentikazzjoni JWT.

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

Ċwievet API

MethodPathDescription
GET/api/v1/keysElenka ċ-ċwievet API kollha tal-kont tiegħek.
POST/api/v1/keysOħloq ċavetta API ġdida.
GET/api/v1/keys/{id}Ikseb id-dettalji ta' ċavetta API speċifika.
PUT/api/v1/keys/{id}Aġġorna s-settings ta' ċavetta API.
DELETE/api/v1/keys/{id}Ħassar ċavetta API. Din l-azzjoni hija irreversibbli.
POST/api/v1/keys/{id}/rotateIddawwar ċavetta API. Iċ-ċavetta l-qadima tiġi invalidata minnufih.

Regoli tal-Formoli

MethodPathDescription
GET/v1/form-rulesAqra r-regoli attivi tal-formoli għal ċavetta. Il-widget innifsu jsejjaħ din ir-rotta; hija l-uniku endpoint għal regoli tal-formoli.
GET/api/v1/keys/{id}/formrules/dryrunIpprova regola fuq l-aħħar formoli identifikati, mingħajr ma tissalva.

Ir-regoli tal-formoli jinżammu fid-dashboard, mhux permezz tal-API — il-ħolqien, il-bidla u t-tħassir hawn m’humiex disponibbli b’mod intenzjonat.

Regoli tal-Allerts

MethodPathDescription
GET/api/v1/keys/{id}/alertsElenka r-regoli tal-allerts kollha għal ċavetta API.
POST/api/v1/keys/{id}/alertsOħloq regola tal-allert ġdida.
DELETE/api/v1/keys/{id}/alerts/{alertId}Ħassar regola tal-allert.