APIs zur Verwaltung der API-Sicherheit verwenden

Last published : Oct 02, 2026
Sie können auf die APIs zugreifen, um eine API-Sicherheit zu erstellen, zu konfigurieren und bereitzustellen.
Hinweis:
Um zu verstehen, wie API-Sicherheits-APIs zur Konfiguration der Funktion verwendet werden, siehe die Nitro API-Dokumentation.
Schritte Ressourcen-URL
1 Eine API-Definition erstellen https://adm.cloud.com/{customerid}/apisec/nitro/v1/config/apidefs
2 Einen API-Proxy hinzufügen https://adm.cloud.com/apiproxies
3 Eine API-Instanz mithilfe des API-Proxys bereitstellen https://adm.cloud.com/apiproxies/{customerid}/deployments
4 API-Richtlinien hinzufügen https://adm.cloud.com/{customerid}/apisec/nitro/v1/config/policies/{id}
Jede API-Richtlinie hat ein anderes config_spec-Objekt. Es ist ein undurchsichtiges Objekt, das ein JSON-Wörterbuch enthält, um ein policytype mit spezifischen Werten zu konfigurieren.
In diesem Objekt können Sie eine API-Ressource und ihre Methoden mit den folgenden Optionen auswählen:
  • api-resource-paths – Geben Sie die API-Ressourcenpfade und -Methoden an, die in einer API-Definition definiert sind.
    Beispiel:
    {
    "endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
       "get": true,
       "post": false,
       "put": false,
       "delete": false
    }
  • custom-rules – Geben Sie die benutzerdefinierten API-Ressourcenpfade und -Methoden an, die möglicherweise nicht in einer API-Definition vorhanden sind.
    Beispiel:
    {
    "endpoints": ["/pet/categories", "/pet/findByName"],
       "get": true,
       "post": false,
       "put": false,
       "delete": false
    }
Mit dieser Konfiguration filtert die Richtlinie die eingehenden Datenverkehrsanfragen, die den angegebenen API-Ressourcenpfaden entsprechen.
Informationen zu config_spec der einzelnen Richtlinientypen finden Sie unter API-Beispiele für Richtlinientypen.
Related information
API-Sicherheit

API-Beispiele für Richtlinientypen

Dieser Abschnitt beschreibt die unterstützten API-Richtlinientypen und deren Konfiguration:

Ratenbegrenzung

Im Folgenden finden Sie eine Beispielkonfiguration für den Ratelimit-Richtlinientyp. Geben Sie die folgende Konfiguration im config_spec-Objekt an:
{
    "policytype": "Ratelimit",
    "config_spec": {
        "api-resource-paths": {
            "endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
            "get": true,
            "post": false,
            "put": false,
            "delete": false
        },
        "custom-rules": {},
        "threshold": "10",
        "timeslice": "20000",
        "limittype": "BURSTY",
        "api-respondertype": "DROP",
        "header_name": "x-api-key",
        "per_client_ip": true
    },
    "order_index": 1,
    "policy_name": "ratelimit_policy"
}
Weitere Informationen zu jedem Attribut finden Sie unter Ratenbegrenzungsrichtlinie.

OAuth

Im Folgenden finden Sie eine Beispiel-API-Konfiguration für den JWT Auth validation-Richtlinientyp. Geben Sie die folgende Konfiguration im config_spec-Objekt an:
{
    "policytype": "JWT Auth Validation",
    "config_spec": {
        "api-resource-paths": {
            "endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
            "get": true,
            "post": true,
            "put": false,
            "delete": false
        },
        "custom-rules": {},
        "jwks-uri": "https://uri.petstore.com",
        "issuer": "https://issuer.petstore.com",
        "audience": "petstore",
        "introspect-uri": "https://introspect.uri.com",
        "clientid": "client",
        "clientsecret": "clientsecret",
        "claims-to-save": ["scope", "scope2"],
        "allowed-algorithms": {
            "hs256": true,
            "rs256": true,
            "rs512": true
        }
    },
    "order_index": 2,
    "policy_name": "Jwt_auth_policy"
}
Weitere Informationen zu jedem Attribut finden Sie unter OAuth-Richtlinie

Basisauthentifizierung

Das Folgende ist eine Beispiel-API-Konfiguration für den BasicAuth Richtlinientyp:
{
    "config_spec": {
        "api-resource-paths": {
            "delete": false,
            "endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
            "get": true,
            "post": true,
            "put": false
        },
        "custom-rules": {}
    },
    "order_index": 3,
    "policy_name": "Auth_BaSIC",
    "policytype": "BasicAuth"
}
Weitere Informationen zu jedem Attribut finden Sie unter Basic authentication policy.

Keine Authentifizierung

Das Folgende ist eine Beispiel-API-Konfiguration für den NoAuth Richtlinientyp:
{
    "config_spec": {
        "api-resource-paths": {
            "delete": false,
            "endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
            "get": true,
            "post": false,
            "put": false
        },
        "custom-rules": {}
    },
    "order_index": 4,
    "policy_name": "no_auth_policy",
    "policytype": "NoAuth"
}

Bot

Das Folgende ist eine Beispiel-API-Konfiguration für den Bot Richtlinientyp:
{
    "config_spec": {
        "api-resource-paths": {
            "delete": false,
            "endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
            "get": false,
            "post": false,
            "put": false
        },
        "bot-prof-name": "apisec_test_profile",
        "custom-rules": {}
    },
    "order_index": 5,
    "policy_name": "bot_policy",
    "policytype": "Bot"
}
Weitere Informationen zu jedem Attribut finden Sie unter Bot policy.

WAF

Das Folgende ist eine Beispiel-API-Konfiguration für den WAF-Richtlinientyp:
{
    "config_spec": {
        "api-resource-paths": {
            "delete": false,
            "endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
            "get": false,
            "post": false,
            "put": false
        },
        "waf-prof-name": "apisec_waf_profile",
        "custom-rules": {}
    },
    "order_index": 6,
    "policy_name": "waf_policy",
    "policytype": "WAF"
}
Weitere Informationen zu jedem Attribut finden Sie unter WAF policy.

Header-Umschreibung

Das Folgende ist eine Beispiel-API-Konfiguration für den Richtlinientyp für Header-Umschreibung. Geben Sie diese Konfiguration im config_spec Objekt an:
{
    "policytype": "Header Rewrite",
    "config_spec": {
        "api-resource-paths": {
            "endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
            "get": true,
            "post": true,
            "put": false,
            "delete": false
        },
        "custom-rules": {},
        "rewrite-policy-header-field-name": "org",
        "rewrite-policy-header-field-val": "Citrix",
        "rewrite-policy-header-field-new-val": "Citrite"
    },
    "order_index": 7,
    "policy_name": "header_rewrite_pol"
}
Weitere Informationen zu jedem Attribut finden Sie unter Header Rewrite policy.

URI-Pfad-Umschreibung

Das Folgende ist eine Beispiel-API-Konfiguration für den Richtlinientyp für URI-Pfad-Umschreibung:
{
    "config_spec": {
        "api-resource-paths": {
            "endpoints": ["/store/order", "/store/inventory"],
            "delete": false,
            "get": true,
            "post": true,
            "patch": false,
            "put": false
        },
        "custom-rules": {
            "delete": false,
            "endpoints": [],
            "get": false,
            "post": false,
            "patch": false,
            "put": true
        },
        "path-rewrite-params": [
        {
            "insert-segment-position": "beginning",
            "new-path-value": "v3",
            "old-path-value": "v2",
            "action-type": "replace path segment"
        },
        {
            "insert-segment-position": "beginning",
            "new-path-value": "begin",
            "action-type": "insert path segment"
        },
        {
            "insert-segment-position": "end",
            "new-path-value": "end",
            "action-type": "insert path segment"
        },
        {
            "insert-segment-position": "before",
            "new-path-value": "before",
            "old-path-value": "store",
            "action-type": "insert path segment"
        },
        {
            "insert-segment-position": "after",
            "new-path-value": "after",
            "old-path-value": "store",
            "action-type": "insert path segment"
        }
        ]
    },
        "order_index": 24,
        "policy_name": "eats_uripathrewrite",
        "policytype": "URI Path Rewrite”
}
Weitere Informationen zu jedem Attribut finden Sie unter URI Path Rewrite policy.

Autorisierung

Im Folgenden finden Sie eine Beispiel-API-Konfiguration für den Authorization Richtlinientyp. Geben Sie die folgende Konfiguration im config_spec Objekt an:
{
    "policytype": "Authorization",
    "config_spec": {
        "api-resource-paths": {
            "endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
            "get": true,
            "post": true,
            "put": false,
            "delete": false
        },
        "custom-rules": {},
        "claims": [{
            "name": "scope",
            "values": ["value1", "value2"]
        }]
    },
    "order_index": 8,
    "policy_name": "authorization"
}
Weitere Informationen zu jedem Attribut finden Sie unter Authorization policy.

Verweigern

Im Folgenden finden Sie eine Beispiel-API-Konfiguration für den Deny Richtlinientyp. Geben Sie die folgende Konfiguration im config_spec Objekt an:
{
    "policytype": "Deny",
    "config_spec": {
        "api-resource-paths": {
            "endpoints": ["/pet", "/pet/findByStatus", "/pet/findByTags"],
            "get": true,
            "post": true,
            "put": false,
            "delete": false
        },
        "custom-rules": {},
        "api-denytype": "RESPONDWITH"
    },
    "order_index": 9,
    "policy_name": "deny_policy"
}
In api-denytype können Sie einen der folgenden Werte angeben:
  • RESPONDWITH
  • RESET
Weitere Informationen zu jedem Attribut finden Sie unter Deny rule.