Überblick über die API für sichere Endgeräte

Problem

In diesem Dokument wird die Verwendung der Cisco Secure Endpoints (SE)-API beschrieben.

Auflösung

Um die SE-API zu verwenden, erstellen Sie in der SE-Konsole eine API-Anmeldeinformation.

In den Beispielen in diesem Artikel wird ein Windows 7-Endpunkt verwendet.

1. Melden Sie sich bei der Konsole an, und navigieren Sie zu Accounts > API Credentials.

1. Klicken Sie auf Neue API-Anmeldeinformationen, um einen neuen Schlüsselsatz zu erstellen.

2. Geben Sie einen Anwendungsnamen ein. Wählen Sie den Bereich Schreibgeschützt oder Lesen und Schreiben aus.

Anmerkung: Mit API-Anmeldeinformationen mit Lese- und Schreibzugriff können Sie Ihre Cisco SE-Konfiguration ändern, was zu erheblichen Problemen mit Ihren Endgeräten führen kann.  Einige der in die Cisco SE-Konsole integrierten Eingabeschutzfunktionen gelten nicht für die API.

3. Klicken Sie auf die Schaltfläche Erstellen. Die Seite API Key Details (API-Schlüsseldetails) wird angezeigt. Speichern Sie diese Informationen, da einige nach dem Verlassen des Bildschirms nicht mehr verfügbar sind.

Anmerkung: API-Anmeldeinformationen (API Client ID und API Key) ermöglichen anderen Programmen das Abrufen und Ändern Ihrer Cisco SE-Daten. Die Funktion entspricht einem Benutzernamen und einem Kennwort und muss entsprechend behandelt werden.

Vorsicht: Ihre API-Anmeldeinformationen werden nur einmal angezeigt. Wenn Sie die Anmeldeinformationen verlieren, müssen Sie neue generieren.

Löschen Sie die API-Anmeldeinformationen für eine Anwendung, wenn Sie vermuten, dass sie kompromittiert wurden, und erstellen Sie eine neue.  Wenn Sie API-Anmeldeinformationen löschen, sperrt es den Client, der die alten verwendet, und aktualisiert sie mit den neuen Anmeldeinformationen.

Umwelt

• Getesteter Endpunkt: Windows 7-Endgerät.
• Produkt: Cisco SE
• Zugriff: Konsolenzugriff mit Berechtigung zum Erstellen und Löschen von API-Anmeldeinformationen.
• API: SE API Version 3, Version 1 und Version 0 (Beispiele verwenden Version 1).
• Client-Tool: curl, das auf dem System installiert ist, das zum Ausführen von API-Anforderungen verwendet wird.

Derzeit gibt es drei Versionen der SE-API: Version 3, Version 1 und Version 0. Version 3 bietet zusätzliche Funktionen im Vergleich zu Version 1 und Version 0. Die API-Dokumentation für Version 3 steht unter diesem Link zur Verfügung. Verwenden Sie Version 3, um diese Informationen abzurufen:

• Überwachungsprotokolle
• Gerätesteuerung
• Geräte
• Ausschlüsse
• Host-Firewall
• IOC
• MSSP
• Organisationen
• Richtlinien
• Computer
• Schwachstellen

Klicken Sie auf den entsprechenden Befehl im Dokument, um Beispiele seiner Verwendung anzuzeigen. 

API-Befehls-Aufschlüsselung und Beispiel

Jeder API-Befehl enthält ähnliche Informationen und gliedert sich in einen Curl-Befehl wie diesen:

curl -o yourfilename.json https://client_id:api_key@api.example.com/v1/whatyouwanttodo

Wenn Sie den Befehl curl mit der Option -o verwenden, können Sie die Ausgabe in einer Datei speichern. In diesem Fall lautet der Dateiname "yourfilename.json". 

Tipp: Weitere Informationen zu .json-Dateien finden Sie auf der JSON-Website.

Im nächsten Teil des curl-Befehls werden Anmeldeinformationen vor dem @-Symbol angegeben. Verwenden Sie nach dem Generieren der API-Anmeldeinformationen die API-Client-ID und den API-Schlüssel in diesem Teil der URL.

https://client_id:api_key@

Fügen Sie die Versionsnummer und die durchzuführende Aktion hinzu. Führen Sie für dieses Beispiel GET /v1/computers aus. Der vollständige Befehl sieht wie folgt aus:

curl -o computers.json https://client_id:api_key@api.example.com/v1/computers

Nachdem Sie den Befehl ausgeführt haben, wird in dem Verzeichnis, in dem Sie den Befehl initiiert haben, die Datei computers.json angezeigt.

Anmerkung: Curl ist online verfügbar und kompiliert für viele Plattformen, einschließlich Windows (in der Regel wollen Sie die Win32 - Generic Version verwenden).

Wenn Sie die Datei öffnen, werden alle Daten in einer einzigen Zeile angezeigt. Um es in einem formatierten Layout anzuzeigen, installieren Sie ein Browser-Plugin, das JSON formatiert und öffnen Sie die Datei in einem Browser. Diese Ausgabe zeigt Informationen für Ihre Computer an, z. B.:

connector_guid, hostname, active, links, connector_version, operating_system, internal_ips, external_ip, group_guid, network_adressen, policy guid und policy name.

{
version: "v1.0.0",
metadata: {
links: {
self: "https://api.amp.cisco.com/v1/computers"
},
results: {
total: 4,
current_item_count: 4,
index: 0,
items_per_page: 500
}
},
data: [
{
connector_guid: "abcdef-1234-5678-9abc-def123456789",
hostname: "host.example.com",
active: true,
links: {
computer: "https://api.amp.cisco.com/v1/computers/abcdef-1234-5678-9abc-def123456789",
trajectory: "https://api.amp.cisco.com/v1/computers/abcdef-1234-5678-9abc-def123456789/trajectory",
group: "https://api.amp.cisco.com/v1/groups/abcdef-1234-5678-9abc-def123456789"
},
connector_version: "4.4.2.10200",
operating_system: "Windows 7, SP 1.0",
internal_ips: [
"10.1.1.2",
" 192.168.1.2",
" 192.168.2.2",
" 169.254.245.1"
],
external_ip: "192.0.2.10",
group_guid: "abcdef-1234-5678-9abc-def123456789",
network_addresses: [
{
mac: "ab:cd:ef:01:23:45",
ip: "10.1.1.2"
},
{
mac: "bc:de:f0:12:34:56",
ip: "192.168.1.2"
},
{
mac: "cd:ef:01:23:45:67",
ip: "192.168.2.2"
},
{
mac: "de:f0:12:34:56:78",
ip: "169.254.245.1"
}
],
policy: {
guid: "abcdef-1234-5678-9abc-def123456789",
name: "Protect Policy"
}
}
]
}

Dieses Beispiel zeigt eine grundlegende API-Anforderung. Sie können jetzt andere Befehlsoptionen verwenden, um Daten in Ihrer Umgebung abzurufen und zu ändern.

Verwandte Inhalte

• API-Dokumentation für Cisco AMP für Endgeräte
• Technischer Support und Dokumentation für Cisco Systeme

Revisionsverlauf

Überarbeitung	Veröffentlichungsdatum	Kommentare
2.0	26-Oct-2026	Rezertifizierung
1.0	20-Mar-2017	Erstveröffentlichung