Security Actions API

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Neben der Verwendung von Sicherheitsaktionen in der Apigee-Benutzeroberfläche können Sie auch über die Apigee API auf alle Funktionen von Sicherheitsaktionen zugreifen.

Einschränkungen bei Sicherheitsaktionen

Sicherheitsaktionen werden auf Ebene der Apigee-Umgebung erzwungen. Für jede Umgebung gelten bei Sicherheitsaktionen die folgenden Einschränkungen:

  • Es sind maximal 1.000 aktivierte Aktionen für eine Umgebung zulässig.
  • Sie können pro Aktion maximal 5 Flag-Header hinzufügen.

Latenzen

Sicherheitsaktionen haben folgende Latenzen:

  • Wenn Sie eine Sicherheitsaktion erstellen, kann es bis zu 10 Minuten dauern, bis die Aktion wirksam wird. Nachdem eine Aktion wirksam und auf API-Traffic angewendet wurde, können Sie die Auswirkungen der Aktion auf der Seite Sicherheitsaktionsdetails sehen. Hinweis: Selbst wenn die Aktion wirksam wurde, können Sie dies nur auf der Seite mit den Details zu den Sicherheitsaktionen erkennen, wenn die Aktion auf einen Teil des API-Traffics angewendet wurde.
  • Bei aktivierten Sicherheitsaktionen erhöht sich die Antwortzeit von API-Proxys geringfügig (weniger als 2 %).

Sicherheitsaktionen erstellen

Die folgenden Beispiele zeigen, wie Sie Sicherheitsaktionen mit API-Aufrufen erstellen. Für alle Beispiele gilt:

  • ORG ist die Organisation.
  • ENV ist die Umgebung für die Sicherheitsaktion.
  • ACTION_NAME ist der Name der Sicherheitsaktion.

Deny-Aktion erstellen

Geben Sie einen Befehl wie diesen ein, um eine Deny-Aktion zu erstellen:

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -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 -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME" \
        -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 -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
        -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.

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 -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:enable"

Dies gibt eine Antwort wie die folgende zurück:

{
      "name": "ACTION_ALLOW",
      "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 -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:disable"

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 abrufen

Geben Sie einen Befehl wie diesen ein, um eine Sicherheitsaktion zu abzurufen:

curl -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"

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 -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions"

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 -XPATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
                -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//environments/ENV/securityActionsConfig",
      "enabled": false,
      "updateTime": "2023-01-23T21:44:58.063807Z"
    }
}

Pausierte Sicherheitsaktionen fortsetzen

Geben Sie einen Befehl wie diesen ein, um pausierte Sicherheitsaktionen fortzusetzen:

curl  -XPATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
                -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"
    }
}