Diese Seite gilt für Apigee und Apigee Hybrid.
Apigee Edge-Dokumentation aufrufen
Auf dieser Seite wird beschrieben, wie Sie Sicherheitsaktionen mit den Apigee Management APIs verwalten. Eine Übersicht über die Funktion „Sicherheitsaktionen“, einschließlich Einschränkungen und Latenzen, finden Sie unter Sicherheitsaktionen – Übersicht und Benutzeroberfläche.
Sie können über die Apigee Management APIs auf alle Funktionen von Sicherheitsaktionen zugreifen. Informationen zu allen verfügbaren Befehlen finden Sie in der Security Actions API-Referenz. Auf dieser Seite finden Sie Beispiele für einige der verfügbaren Befehle.
In Beispielen verwendete Variablen
Die Beispiele auf dieser Seite können diese Variablen enthalten:
ORG
ist die Organisation.ENV
ist die Umgebung für die Sicherheitsaktion.ACTION_NAME
ist der Name der Sicherheitsaktion.
Sicherheitsaktionen erstellen
In diesem Abschnitt finden Sie Beispiele für das Erstellen von Sicherheitsaktionen mit verschiedenen Aktionstypen.
Deny-Aktion erstellen
Geben Sie einen Befehl wie diesen ein, um eine Deny-Aktion zu erstellen:
curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"state": "ENABLED", "deny": {"response_code": 404}, "condition_config": {"ip_address_ranges": ["100.0.225.0"]}}'
Dadurch wird eine Sicherheitsaktion erstellt, die den Zugriff auf Anfragen an die nach ip_address_ranges
aufgeführten IP-Adressen verweigert und den Antwortcode 404
zurückgibt.
Flag-Aktion erstellen
Geben Sie einen Befehl wie diesen ein, um eine Flag-Aktion zu erstellen:
curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"state": "ENABLED", "flag": {"headers": [{"name": "senseflag", "value": "flagvalue"}]}, "condition_config": {"ip_address_ranges": ["100.0.230.0"]}}'
Dadurch wird eine Sicherheitsaktion erstellt, die Anfragen von den nach ip_address_ranges
aufgeführten IP-Adressen kennzeichnet und einen Header senseflag
mit dem Wert flagvalue
hinzufügt.
Allow-Aktion erstellen
Geben Sie zum Erstellen einer Allow-Aktion einen Befehl wie den folgenden ein:
curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"state": "ENABLED", "allow": {}, "condition_config": {"ip_address_ranges": ["100.0.220.0", "200.0.0.0"]}}'
Dadurch wird eine Sicherheitsaktion erstellt, die Anfragen von den nach ip_address_ranges
aufgeführten IP-Adressen zulässt.
Sicherheitsmaßnahmen bearbeiten
In diesem Abschnitt finden Sie ein Beispiel dafür, wie Sie eine vorhandene Konfiguration für Sicherheitsaktionen bearbeiten. Beispiele für diese Arten von Änderungen finden Sie unter Sicherheitsaktion aktivieren oder deaktivieren oder Sicherheitsaktion löschen.
Deny-Aktion bearbeiten
In diesem Abschnitt finden Sie ein Beispiel für das Bearbeiten einer Ablehnungsaktion. Die APIs unterstützen auch das Bearbeiten der anderen Aktionstypen.
update_mask
kann eine der folgenden Optionen enthalten: description,condition_config,
api_proxies,expire_time,ttl,flag,allow,deny,*
(alles) oder ausgelassen werden (Standardeinstellung: alles).
Weitere Informationen zu möglichen Werten beim Bearbeiten von Aktionen finden Sie in der Referenzdokumentation zur Security Actions API.
curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME?update_mask=deny,condition_config" \ -H "Authorization: Bearer $TOKEN" \ -d '{"deny": {"response_code": 404}, "condition_config": {"ip_address_ranges": ["100.0.230.0"]}}' \ -H "Content-Type: application/json" { "name": "ACTION_NAME", "state": "ENABLED", "createTime": "2022-12-29T18:28:50Z", "updateTime": "2022-12-29T18:28:50Z", "conditionConfig": { "ipAddressRanges": [ "100.0.230.0" ] }, "deny": { "responseCode": 404 } }
Sicherheitsaktion aktivieren oder deaktivieren
Die folgenden Beispiele zeigen API-Aufrufe zum Aktivieren oder Deaktivieren von Sicherheitsaktionen.
Sicherheitsaktion aktivieren
Geben Sie einen Befehl wie diesen ein, um eine Sicherheitsaktion zu aktivieren:
curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:enable" -H "Authorization: Bearer $TOKEN"
Dies gibt eine Antwort wie die folgende zurück:
{ "name": "ACTION_NAME", "state": "ENABLED", "createTime": "2022-12-29T18:27:31Z", "updateTime": "2023-01-03T23:19:26.650965481Z", "conditionConfig": { "ipAddressRanges": [ "100.0.220.0", "200.0.0.0" ] }, "allow": {}, "expireTime": "2028-01-01T00:00:00Z" }
Sicherheitsaktion deaktivieren
Geben Sie einen Befehl wie diesen ein, um eine Sicherheitsaktion zu deaktivieren:
curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:disable" -H "Authorization: Bearer $TOKEN"
Dies gibt eine Antwort wie die folgende zurück:
{ "name": "actionallow", "state": "DISABLED", "createTime": "2022-12-29T18:27:31Z", "updateTime": "2023-01-03T23:13:04.874540001Z", "conditionConfig": { "ipAddressRanges": [ "100.0.220.0", "200.0.0.0" ] }, "allow": {}, "expireTime": "2028-01-01T00:00:00Z" }
Sicherheitsaktionen abrufen oder auflisten
Die folgenden Beispiele zeigen, wie Sie Sicherheitsaktionen abrufen oder auflisten
Sicherheitsaktion erhalten
Geben Sie einen Befehl wie diesen ein, um eine Sicherheitsaktion zu abzurufen:
curl -X GET "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME" -H "Authorization: Bearer $TOKEN"
Dies gibt eine Antwort wie die folgende zurück:
{ "name": "ACTION_NAME", "state": "DISABLED", "createTime": "2022-12-29T18:27:31Z", "updateTime": "2023-01-03T23:13:04Z", "conditionConfig": { "ipAddressRanges": [ "100.0.220.0", "200.0.0.0" ] }, "allow": {}, "expireTime": "2028-01-01T00:00:00Z" }
Sicherheitsaktionen auflisten
Geben Sie einen Befehl wie diesen ein, um alle Sicherheitsaktionen aufzulisten:
curl -X GET "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions" -H "Authorization: Bearer $TOKEN"
Sicherheitsaktionen pausieren oder fortsetzen
Die folgenden Beispiele zeigen, wie Sie Sicherheitsaktionen pausieren oder fortsetzen können.
Alle Sicherheitsaktionen pausieren
Geben Sie einen Befehl wie diesen ein, um alle Sicherheitsaktionen zu pausieren:
curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"enabled": "false", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'
Dies gibt eine Antwort wie die folgende zurück:
{ "name": "organizations/ORG/environments/ENV/securityActionsConfig", "enabled": false, "updateTime": "2023-01-23T21:44:58.063807Z" }
Angehaltene Sicherheitsmaßnahmen fortsetzen
Geben Sie einen Befehl wie diesen ein, um pausierte Sicherheitsaktionen fortzusetzen:
curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{"enabled": "true", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'
Dies gibt eine Antwort wie die folgende zurück:
{ "name": "organizations/ORG/environments/ENV/securityActionsConfig", "enabled": true, "updateTime": "2023-01-23T21:44:58.063807Z" }
Sicherheitsaktionen löschen
Geben Sie einen Befehl wie diesen ein, um eine Sicherheitsaktion zu löschen:
curl -X DELETE "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME" -H "Authorization: Bearer $TOKEN"