Frage oder Herausforderung

Was kann die Managed Security Audit API?

Lösung oder Antwort

Die Lywand API bietet dir eine Vielzahl von Möglichkeiten, um deine Arbeit zu erleichtern. Hier einige Beispiele, was du damit tun kannst:

Kunden verwalten: Lege neue Kunden an, rufe ihre Daten ab, bearbeite oder lösche sie.
Ziele verwalten: Füge neue Ziele für deine Kunden hinzu oder entferne sie.
Scans starten: Starte Scans für die Ziele deiner Kunden und rufe die Ergebnisse ab.
Analysen abrufen: Greife direkt auf Analysen und Kennzahlen zu, um die Sicherheit deiner Kunden jederzeit im Blick zu haben.

API-Schlüssel erstellen

Um die Lywand API nutzen zu können, benötigst du einen API-Schlüssel. Diesen kannst du ganz einfach im IT-Dienstleister Menü unter Einstellungen > API anlegen.

Hier kannst du neue API-Schlüssel erstellen und bestehende löschen.
Du kannst mehrere Schlüssel gleichzeitig nutzen.
Im oberen Bereich der Seite siehst du auch eine Übersicht über die API-Anfragen, die du im aktuellen Monat bereits gestellt hast.

API-Beschreibung

Sobald du deinen API-Schlüssel hast, kannst du gegen die URL https://api01.lywand.com arbeiten. Eine detaillierte OpenAPI Beschreibung findest du ebenfalls unter dieser URL.

Verwendung der API im Kundenkontext

Alle API-Anfragen werden immer im Kontext des Accounts ausgeführt, mit dem du den API-Schlüssel erstellt hast. Möchtest du auf die Daten eines bestimmten Kunden zugreifen oder Aktionen für diesen Kunden ausführen, musst du diesen Kundenkontext angeben.

Das kannst du über den Parameter ?tenant=tenant_id in der URL tun, um die Anfrage für den jeweiligen Kunden auszuführen.

Beispiel:

curl -X 'GET' \
  'https://api01.lywand.com/api/v1/results/vulnerabilities/?tenant=tenant_id' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'

Tipp: Verwende die tatsächliche Tenant ID deines Kunden anstelle von "tenant_id".

Praktische Beispiele zur Verwendung der API

1. Überblick über alle Kunden (Partner Dashboard)

curl -X 'GET' \
  'https://api01.lywand.com/api/v1/partner/dashboard/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'

2. Neuen Kunden erstellen

curl -X 'POST' \
  'https://api01.lywand.com/api/v1/tenants/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{ "companyName": "string", "companySize": "string", "licenseKey": "string", "website": "string", "sector": "string", "billingAddress": { "country": "string", "postalCode": "string", "city": "string", "street": "string" }, "setupComplete": true, "customerReference": "string", "contractReference": "string", "createDemoAccount": true }'

3. Kundenübergreifender Überblick aller Schwachstellen (Analyse Dashboard)

curl -X 'GET' \
  'https://api01.lywand.com/api/v1/partner/analysis/vulnerabilities' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'

4. Ziele eines Kunden abfragen

curl -X 'GET' \
  'https://api01.lywand.com/api/v1/infrastructure/targets/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'

5. Ein neues Ziel anlegen

curl -X 'POST' \
  'https://api01.lywand.com/api/v1/infrastructure/targets/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{ "identifier": "string" }'

6. Ein Ziel löschen

curl -X 'POST' \
  'https://api01.lywand.com/api/v1/infrastructure/targets/bulk/delete' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{ "identifiers": [ "string" ] }'

7. Ein Ziel ändern

curl -X 'PUT' \
  'https://api01.lywand.com/api/v1/infrastructure/targets/bulk/update' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "targets": [
    {
      "identifier": "string",
      "name": "string",
      "active_directory": {
        "domain": "",
        "distinguished_name": ""
      },
      "display_name": "string",
      "target_type": "string",
      "ips": [
        "string"
      ]
    }
  ]
}'

8. Einen externen Scan starten

curl -X 'POST' \
  'https://api01.lywand.com/api/v1/scans/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE' \
  -H 'accept: application/json'

🔗 Weitere Artikel

Hier findest du weitere Artikel zu diesem Produkt.

Anleitung | API - Ein einfacher Leitfaden