🔗 Verwendung der API

Was kann die lywand API?

Viele Bereiche und Funktionen von lywand können über API-Requests automatisiert gesteuert werden. Diese FAQ soll Ihnen einen Überblick über die Nutzung der API geben, damit Sie schnell loslegen können.

Mit der lywand API können Sie beispielsweise:

• Kunden verwalten: Kunden anlegen, deren Daten abfragen, bearbeiten oder löschen

• Ziele verwalten: Ziele Ihrer Kunden hinzufügen und entfernen

• Scans starten: Scans für Ihre Ziele starten und Ergebnisse abrufen

• Analysen abrufen: Direkten Zugriff auf Analysen und Kennzahlen, um die Sicherheit Ihrer Kunden im Blick zu behalten

API-Schlüssel erstellen

Um die lywand API nutzen zu können, benötigen Sie einen API-Schlüssel, den Sie anschließend mit Ihren Diensten verknüpfen können. Um einen neuen Schlüssel zu erstellen, navigieren Sie im IT-Dienstleister Menü zu Einstellungen > API.

Hier können Sie neue API-Schlüssel anlegen und bestehende entfernen. Sie können gleichzeitig mehrere Schlüssel in Verwendung haben. Außerdem erhalten Sie auf der Seite oben rechts einen Überblick über die von Ihnen gestellten API-Anfragen für den aktuellen Monat.

API-Beschreibung

Mit dem erstellten API-Schlüssel kann gegen die URL https://api01.lywand.com entwickelt werden. Eine detaillierte OpenAPI Beschreibung ist unter dieser URL ebenfalls verfügbar.

Beispiele zur Verwendung

Hier finden Sie einige grundlegende Beispiele, die Ihnen den Einstieg in die Verwendung der lywand API erleichtern:

• Überblick über alle Kunden (Partner Dashboard)

Erhalten Sie einen detaillierten Überblick über alle Ihre Kunden:

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

• Neuen Kunden erstellen

Legen Sie einen neuen Kunden plus Kundeninformationen an:

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 }'

• Kundenübergreifender Überblick aller Schwachstellen und Produkte (Analyse Dashboard)

Fragen Sie Metriken aus dem Analyse Dashboard ab:

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

• Ziele eines Kunden abfragen

Holen Sie sich einen Überblick über alle Ziele eines Kunden:

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

• Ziel anlegen

Legen Sie ein neues externes Ziel für einen Kunden an:

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" }' 

• Ziel löschen

Löschen Sie eines oder mehrere Ziele eines Kunden:

curl -X 'POST' \
  'http://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" ] }'

• Ziel ändern

Ändern Sie Infos für ein oder mehrere Ziele eines Kunden:

curl -X 'PUT' \
  'http://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"
      ]
    }
  ]
}'

• Einen externen Scan starten

Starten Sie einen externen Scan:

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'

Verwendung der API im Kontext eines Kunden

Alle API-Anfragen werden grundsätzlich im Kontext des Accounts ausgeführt, mit dem der API-Schlüssel erstellt wurde. Wenn Sie auf Daten eines Kunden zugreifen möchten oder im Kunden Aktionen tätigen wollen, müssen Sie dazu diesen speziellen Kundenkontext angeben.

Sie können dazu den Parameter ?tenant=tenant_id in der URL angeben. Dieser Parameter erlaubt es, die Anfrage für einen bestimmten 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'

Bitte beachten Sie, dass Sie statt dem String "tenant_id", die tatsächliche Tenant ID Ihres Kunden angeben müssen.

Übersetzung von Inhalten

Schwachstellen, Maßnahmen und diverse andere Inhalte werden von der API transparent übersetzt. Dafür kann der HTTP Header "Accept-Language" verwendet werden. Aktuell werden Deutsch (de-DE) und Englisch (en-GB) unterstützt.

In diesem Beispiel werden Maßnahmen auf Deutsch retourniert:

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

Hier auf Englisch:

curl -X GET 'https://api01.lywand.com/api/v1/results/measures/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: en-GB'