Funktionsweise von API
Arten von API-Aufrufen
Die ESET PROTECT On-Prem API unterstützt die API-Aufruftypen GET, POST und DELETE.
•GET-Aufrufe enthalten alle gesendeten Eingabeparameter (kein Text enthalten) und Daten direkt in der URL. Der Anforderungsaufruf kann nicht geändert, sondern nur ausgeführt werden.
•POST-Aufrufe enthalten einen Anfragetext: In der Dokumentation finden Sie die Parameter der einzelnen POST-Aufrufe.
•In API-Anfragen mit Paginierung (page_size) ist die standardmäßige Seitengröße 100 und die maximale Größe 10000.
Jeder Aufruf besteht aus:
•Aufruftyp
•Anfrage-URL
•Anfrage-Header (kann aus dem Authentifizierungstoken bestehen)
•Anfragetext (enthält Daten, insbesondere bei POST-Aufrufen)
Struktur der Serverantwort
Jeder API-Aufruf erhält eine Antwort vom REST Server. Die Antwort besteht aus dem Server-Antwortcode und der als JSON-Daten formatierten Antwort.
Die Antwort besteht aus:
•Servercode
•Antworttext
•Antwort-Header
Beispiele für API-Aufrufe
GET
Policy anzeigen (Die Policy_UUID stammt aus der Web-Konsole):
Methode |
GET |
Funktion |
|
URL |
https://protect_server:9443/v2/policies/Policy_UUID |
Körper |
|
Autorisierung |
Bearer token |
POST
Gerät in eine bestimmte statische Gruppe verschieben (Die Computer-ID ist in der URL enthalten):
Methode |
POST |
Funktion |
|
URL |
https://protect_server:9443/v1/devices/a13f7d4c-e689-47cb-939d-91b9c9664a57:move |
Körper |
{ "newParentUuid": "be3d7451-e625-47fb-8f29-f98d61b40db1" } |
Autorisierung |
Bearer token |