{
  "opencollection": "1.0.0",
  "info": {
    "name": "Akamai: API Endpoint Definition Access tokens Shared resources: Custom rules API",
    "version": "2"
  },
  "items": [
    {
      "info": {
        "name": "Shared resources: Custom rules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List custom rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/custom-rules",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__All products__ Lists custom rules defined in a security configuration."
        },
        {
          "info": {
            "name": "Create a custom rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/custom-rules",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "__All products__ Creates a new custom rule."
        },
        {
          "info": {
            "name": "Get a custom rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/custom-rules/:ruleId",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for rule."
              },
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__All products__ Returns the details of a custom rule."
        },
        {
          "info": {
            "name": "Modify a custom rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/custom-rules/:ruleId",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for rule."
              },
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "__All products__ Updates an existing custom rule."
        },
        {
          "info": {
            "name": "Remove a custom rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/custom-rules/:ruleId",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for rule."
              },
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ]
          },
          "docs": "__All products__ Deletes a custom rule as long as it isn't activated."
        },
        {
          "info": {
            "name": "List custom rules usage by security policies",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{hostname}/api-definitions/v2/configs/:configId/versions/:versionNumber/custom-rules/usage",
            "params": [
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each configuration."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "A unique identifier for each version of a configuration."
              },
              {
                "name": "accountSwitchKey",
                "value": "",
                "type": "query",
                "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "__All products__ Returns a list of security policies using each requested custom rule with a set action (Allow or Deny), if any apply. Skips custom rule IDs that do not belong to this security configuration."
        }
      ]
    }
  ],
  "bundled": true
}