{ "opencollection": "1.0.0", "info": { "name": "Akamai: Application Security API", "version": "v1" }, "items": [ { "info": { "name": "Activations", "type": "folder" }, "items": [ { "info": { "name": "Activate a configuration version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/activations", "params": [ { "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__ Activates one or more configurations globally. Note that you need to explicitly list any invalid hosts in the `acknowledgedInvalidHostsByConfig` parameter in order to successfully activate a configuration that includes invalid hostnames. If you have an invalid hostname that isn't explicitly called out you'll receive an error telling you to add them to `acknowledgedInvalidHostsByConfig`. See [Activate with invalid hostnames](https://techdocs.akamai.com/application-security/refere" } ] }, { "info": { "name": "Activation status", "type": "folder" }, "items": [ { "info": { "name": "Get an activation request status", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/activations/status/:statusId", "params": [ { "name": "statusId", "value": "", "type": "path", "description": "UUID of this activation request status." }, { "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 status of a long-running activation request. Any errors that occur when generating the activation cause this API to respond with the underlying error status." }, { "info": { "name": "Get activation status", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/activations/:activationId", "params": [ { "name": "activationId", "value": "", "type": "path", "description": "A unique identifier for an activation." }, { "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 status of an activation." } ] }, { "info": { "name": "Discovered APIs", "type": "folder" }, "items": [ { "info": { "name": "List discovered APIs", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/api-discovery", "params": [ { "name": "includeHidden", "value": "", "type": "query", "description": "If `true`, includes all discovered APIs including ones you have hidden. By default, `false` returns only the visible APIs." }, { "name": "search", "value": "", "type": "query", "description": "Filter results by hostname or basepath. You can also match on substrings." }, { "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__ List APIs discovered in your traffic that are new or not yet protected under API protections. An API is considered new if it isn't registered, and appears in the discovered APIs list if it's had at least 1000 requests over the last 30 days and at least one 2xx response." }, { "info": { "name": "Get a discovered API", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/api-discovery/host/:hostname/basepath/:basePath", "params": [ { "name": "hostname", "value": "", "type": "path", "description": "The base64-encoded value of the hostname." }, { "name": "basePath", "value": "", "type": "path", "description": "The base64-encoded value of the base path." }, { "name": "includeHidden", "value": "", "type": "query", "description": "If `true`, includes all discovered APIs including ones you have hidden. By default, `false` returns only the visible APIs." }, { "name": "search", "value": "", "type": "query", "description": "Filter results by name, description, or ID. You can match on substrings." }, { "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 details about an API discovered in account traffic. It is identified based on hostname and basepath." } ] }, { "info": { "name": "Endpoints", "type": "folder" }, "items": [ { "info": { "name": "Modify an API's visibility", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/api-discovery/host/:hostname/basepath/:basePath", "params": [ { "name": "hostname", "value": "", "type": "path", "description": "The base64-encoded value of the hostname." }, { "name": "basePath", "value": "", "type": "path", "description": "The base64-encoded value of the base path." }, { "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__ Hide or show an API. You can choose to include or exclude APIs from the [Get discovered APIs](https://techdocs.akamai.com/application-security/reference/get-api-list) response. This operation is per-user. If you hide an API from the response, another of your colleagues will still see that API in the response when they run this operation with their own credentials." }, { "info": { "name": "List discovered API endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/api-discovery/host/:hostname/basepath/:basePath/endpoints", "params": [ { "name": "hostname", "value": "", "type": "path", "description": "The base64-encoded value of the hostname." }, { "name": "basePath", "value": "", "type": "path", "description": "The base64-encoded value of the base path." }, { "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 API endpoints for the specified hostname and base path. Unlike [Get discovered APIs](https://techdocs.akamai.com/application-security/reference/get-api-list), this operation returns APIs already in your API definitions. When you see a discovered API or a new resource, add it to your definition with [Create an endpoint or resource](https://techdocs.akamai.com/application-security/reference/post-api-endpoint-resource)." }, { "info": { "name": "Create an endpoint or resource", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/api-discovery/host/:hostname/basepath/:basePath/endpoints", "params": [ { "name": "hostname", "value": "", "type": "path", "description": "The base64-encoded value of the hostname." }, { "name": "basePath", "value": "", "type": "path", "description": "The base64-encoded value of the base path." }, { "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__ Create a new API endpoint or add a resource to an existing endpoint. When you run this operation to add a new resource to an existing API, the API version is cloned for you and the resource is included in the new version." } ] }, { "info": { "name": "General configuration settings", "type": "folder" }, "items": [ { "info": { "name": "List configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs", "params": [ { "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 available security configurations." }, { "info": { "name": "Create a configuration", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs", "params": [ { "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__ Create a new WAP or KSD security configuration. KSD security configurations start out empty, and WAP configurations are created with preset values. The contract you pass in the request body determines which product you use. You can edit the default settings included in the WAP configuration, but you'll need to run additional operations in this API to select specific protections for KSD. Your KSD configuration needs match targets and protection settings before you activate." }, { "info": { "name": "Get a security configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "includeHostnames", "value": "", "type": "query", "description": "If `true`, include the list of hostnames protected by this security configuration in the production network. If `false`, exclude the list of hostnames protected by this security configuration in the production network." }, { "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__ Retrieves the configuration details." }, { "info": { "name": "Rename a security configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId", "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__ Update the name of your security configuration." }, { "info": { "name": "Delete a configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId", "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__ Deletes the specified security configuration." }, { "info": { "name": "List configuration versions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions", "params": [ { "name": "configId", "value": "", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "page", "value": "", "type": "query", "description": "The index of the result page. If the value is `-1`, then pagination is ignored. The default value is `1`." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items on each result page. The default value is `25`." }, { "name": "detail", "value": "", "type": "query", "description": "When `true`, the results contain detailed information on versions. With the default `false`, the results contain summary information on versions." }, { "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 available versions for the specified security configuration, with results optionally paginated." }, { "info": { "name": "Clone a configuration version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions", "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 version of the specified security configuration." }, { "info": { "name": "Get configuration version details", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber", "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)." } ] }, "docs": "__All products__ Returns basic details about a configuration version. To get a more extensive object with detailed information about a version's security policies, rate policies, rules, and other additional settings, run the [Export a configuration version](https://techdocs.akamai.com/application-security/reference/get-export-config-version) operation." }, { "info": { "name": "Delete a configuration version", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber", "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)." } ] }, "docs": "__All products__ Delete the specified configuration version. You can't delete a version that's actively in use." }, { "info": { "name": "Get the version notes", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/version-notes", "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)." } ] }, "docs": "__All products__ Get the most recent version notes for a configuration." }, { "info": { "name": "Modify version notes", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/version-notes", "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__ Update the most recent version notes for a configuration." } ] }, { "info": { "name": "Activation history", "type": "folder" }, "items": [ { "info": { "name": "List activation history", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/activations", "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 the activation history for a configuration. The history is an array in descending order of `submitDate`. The most recent submitted activation lists first." } ] }, { "info": { "name": "Shared resources: Custom rules", "type": "folder" }, "items": [ { "info": { "name": "List custom rules", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/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}/appsec/v1/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}/appsec/v1/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}/appsec/v1/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}/appsec/v1/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}/appsec/v1/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." } ] }, { "info": { "name": "Failover hostnames", "type": "folder" }, "items": [ { "info": { "name": "List failover hostnames", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/failover-hostnames", "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__ Get a list of the failover hostnames in a configuration." } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "List subscribers", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/notification/subscription/:feature", "params": [ { "name": "feature", "value": "", "type": "path", "description": "A unique identifier for each subscription feature." }, { "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": "__Kona Site Defender__ List all subscribers to a security configuration's `feature`. The response array is empty if there are no subscribers. Currently available `feature` values are `AAG_TUNING_REC` for AAG and ASE rule sets, and `WAF_RULE_UPDATE` for ASE rule sets." }, { "info": { "name": "Subscribe or unsubscribe to recommendation emails", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/notification/subscription/:feature", "params": [ { "name": "feature", "value": "", "type": "path", "description": "A unique identifier for each subscription feature." }, { "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": "__Kona Site Defender__ Set the request object's `action` to `subscribe` to add user emails to the subscription object. Use `unsubscribe` to remove them from the list. The lists are organized by `features`. Currently available `feature` values are `AAG_TUNING_REC` for AAG and ASE rule sets, and `WAF_RULE_UPDATE` for ASE rule sets." } ] }, { "info": { "name": "Configuration version diff", "type": "folder" }, "items": [ { "info": { "name": "Compare two versions", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/diff", "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__ This operation shows you differences between configuration versions. The `to` version is relative to the `from` version, and the versions you compare can be non-sequential. This means the `from` value can be more a more recent version than the `to` value. For more information, see [Diff configuration versions](https://techdocs.akamai.com/application-security/reference/diff-configuration-versions)." } ] }, { "info": { "name": "Cookie Settings", "type": "folder" }, "items": [ { "info": { "name": "Get cookie settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/cookie-settings", "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)." } ] }, "docs": "__All products__ Returns cookie settings for a configuration. Contact your account team if you'd like to run this operation." }, { "info": { "name": "Modify cookie settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/cookie-settings", "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__ Modify cookie settings for a configuration. Contact your account team if you'd like to run this operation." } ] }, { "info": { "name": "Evasive path match", "type": "folder" }, "items": [ { "info": { "name": "Get evasive path match settings for a configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/evasive-path-match", "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)." } ] }, "docs": "__Web Application Protector__, __Kona Site Defender__ Lists the evasive path match setting for a configuration. Evasive path match is off by default. This setting applies at the configuration level and applies to all policies within a configuration. If you want to view this setting for a specific policy, run [Get evasive patch match settings](https://techdocs.akamai.com/application-security/reference/get-evasive-path-match)." }, { "info": { "name": "Modify evasive path match settings for a configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/evasive-path-match", "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": "__Web Application Protector__, __Kona Site Defender__ Enable, disable, or update evasive path match settings for a configuration. This operation applies at the configuration level and applies to all policies within a configuration. If you want to override these settings for a specific policy, run [Modify evasive path match settings](https://techdocs.akamai.com/application-security/reference/put-evasive-path-match)." }, { "info": { "name": "Get evasive path match settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/evasive-path-match", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Web Application Protector__, __Kona Site Defender__ Lists the evasive path match setting for a security policy. Evasive path match is off by default. This setting applies at the security policy level and overrides the setting at the configuration level on a per-policy basis." }, { "info": { "name": "Modify evasive path match settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/evasive-path-match", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Web Application Protector__, __Kona Site Defender__ Enable, disable, or update evasive path match setting for a security policy. This operation applies at the security policy level and overrides the setting at the configuration level on a per-policy basis." } ] }, { "info": { "name": "JA4 Client TLS Fingerprint", "type": "folder" }, "items": [ { "info": { "name": "Get JA4 client TLS fingerprint settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/ja4-fingerprint", "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)." } ] }, "docs": "__Beta__, __Web Application Protector__, __Kona Site Defender__ Return JA4 client TLS fingerprint settings for a configuration. JA4 is a client-focused fingerprint based on the client TLS handshake. Use JA4 fingerprinting to mitigate DDoS attacks, detect and mitigate bots, and block known attackers from sending application layer attacks payloads. [Learn more about JA4 fingerprinting]( https://techdocs.akamai.com/app-api-protector/docs/adv-settings)." }, { "info": { "name": "Modify JA4 client TLS fingerprint settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/ja4-fingerprint", "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": "__Beta__, __Web Application Protector__, __Kona Site Defender__ Update JA4 client TLS fingerprint settings for a configuration." } ] }, { "info": { "name": "HTTP header logs", "type": "folder" }, "items": [ { "info": { "name": "Get the HTTP header log settings for a configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/logging", "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)." } ] }, "docs": "__All products__ Lists HTTP header logging controls for a configuration. HTTP header logging is on by default, and in most cases you should leave it enabled. You can filter requests by header type, including or excluding requests with a specific header, or by cookie. This operation applies at the configuration level, and therefore applies to all policies within a configuration. If you want to view these settings for a specific policy, run [Get HTTP header log settings](https://techdocs.akamai.co" }, { "info": { "name": "Modify HTTP header log settings for a configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/logging", "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__ Enable, disable, or update HTTP header Logging settings for a configuration. This operation applies at the configuration level, and therefore applies to all policies within a configuration. If you want to override these settings for a specific policy, run [Modify HTTP header log settings](https://techdocs.akamai.com/application-security/reference/put-policies-logging)." }, { "info": { "name": "Get HTTP header log settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/logging", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ List a security policy's settings for HTTP header logging. HTTP header logging is on by default, and in most cases you should leave it enabled. You can filter requests by header type, including or excluding requests with a specific header, or by cookie. This operation applies at the security policy level, and overrides the HTTP header log settings at the configuration level on a per-policy basis." }, { "info": { "name": "Modify HTTP header log settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/logging", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Enable, disable, or update HTTP header logging settings for a specific policy. This operation applies at the security policy level, and overrides the HTTP header log settings at the configuration level on a per-policy basis." } ] }, { "info": { "name": "Attack payload logs", "type": "folder" }, "items": [ { "info": { "name": "Get the attack payload log settings for a configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/logging/attack-payload", "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)." } ] }, "docs": "__All products__ Lists attack payload log settings for a configuration. When set to `NONE`, the request body and response body show as redacted in the log. For example, `JSON_PAIRS:redacted`. Attack payload logging is on by default, and in most cases you should leave it enabled. This operation applies at the configuration level, and therefore applies to all policies within a configuration. If you want to view these settings for a specific policy, run [Get attack payload logging settings for a po" }, { "info": { "name": "Modify attack payload log settings for a configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/logging/attack-payload", "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__ Enable, disable, or update attack payload log settings for a configuration. When set to `NONE`, the request body and response body show as redacted in the log. For example, `JSON_PAIRS:redacted`. When set to `RESPONSE_BODY` or `REQUEST_BODY` the log shows only the string flagged as a possible attack, and not the entire request or response body. This operation applies at the configuration level, and therefore applies to all policies within a configuration. If you want to override" }, { "info": { "name": "Get attack payload logging settings for a policy", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/logging/attack-payload", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ List a security policy's settings for attack payload logging. Attack payload logging is on by default, and in most cases you should leave it enabled. When set to `NONE`, the request body and response body appear as `redacted` in the log. For example, `JSON_PAIRS:redacted`. This operation applies at the security policy level, and overrides the attack payload logging settings at the configuration level on a per-policy basis." }, { "info": { "name": "Modify attack payload logging settings for a policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/logging/attack-payload", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Update attack payload logging settings for a specific policy. This operation applies at the security policy level, and overrides the attack payload logging settings at the configuration level on a per-policy basis. When set to `NONE`, the request body and response body appear as `redacted` in the log. For example, `JSON_PAIRS:redacted`." } ] }, { "info": { "name": "PII learning", "type": "folder" }, "items": [ { "info": { "name": "Get PII learning settings for a configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/pii-learning", "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)." } ] }, "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Shows whether PII learning is enabled. This operation applies at the security configuration level." }, { "info": { "name": "Enable PII learning settings for a configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/pii-learning", "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Turn on PII learning for your API definition. To enable PII learning, submit your request with a payload of `{\"enablePiiLearning\": true}`. To disable PII learning, submit your request with a payload of `{\"enablePiiLearning\": false}`. This operation applies at the security configuration level. Run [Modify PII settings for an endpoint version](https://techdocs.akamai.com/api-definitions/reference/post-endpoint-versio" } ] }, { "info": { "name": "Pragma settings", "type": "folder" }, "items": [ { "info": { "name": "Get Pragma settings for a configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/pragma-header", "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)." } ] }, "docs": "__All products__ Return the `Pragma` header excluded conditions. By default, the `Pragma` header is stripped from an operation's response except in cases where you set `excludeCondition`. This operation applies at the security configuration level. To see settings at the security policy level, run [List Pragma header settings for a security policy](https://techdocs.akamai.com/application-security/reference/get-policies-pragma-header)." }, { "info": { "name": "Modify Pragma settings for a configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/pragma-header", "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__ Update the `Pragma` header excluded conditions. By default, the `Pragma` header is stripped from an operation's response except in cases where you set `excludeCondition`. To remove existing settings, submit your request with an empty payload `{}` at the top-level of an object. For example, submit `\"type\": \"{}\"` in the request body to remove the `requestHeaderValueMatch` from the excluded conditions. If you submit an empty payload for each field, you'll clear all of your conditio" }, { "info": { "name": "Get Pragma settings for a security policy", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/pragma-header", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Return the `Pragma` header's excluded conditions. By default, the `Pragma` header debugging information is stripped from an operation's response except in cases where you set `excludeCondition`. This operation applies at the security policy level. To modify `Pragma` header settings at the security configuration level, run [List Pragma header settings for a configuration](https://techdocs.akamai.com/application-security/reference/get-advanced-settings-pragma-header)." }, { "info": { "name": "Modify Pragma settings for a security policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/pragma-header", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Update the pragma header excluded conditions. By default, the `Pragma` header debugging information is stripped from an operation's response except in cases where you set `excludeCondition`. To remove existing settings, submit your request with an empty payload `{}` at the top-level of an object. For example, submit `\"type\": \"{}\"` in the request body to remove the `requestHeaderValueMatch` from the excluded conditions. If you submit an empty payload for each field, you'll clear " } ] }, { "info": { "name": "Prefetch requests", "type": "folder" }, "items": [ { "info": { "name": "Get prefetch requests", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/prefetch", "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)." } ] }, "docs": "__Kona Site Defender__ Get Prefetch Request settings." }, { "info": { "name": "Modify prefetch requests", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/prefetch", "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": "__Kona Site Defender__ Enabling this protection causes your application firewall rules to inspect internal requests (those between your origin and Akamai's servers) for file types you specify. You can also apply rate controls to prefetch requests. This operation applies at the configuration level." } ] }, { "info": { "name": "Request body size", "type": "folder" }, "items": [ { "info": { "name": "Get request body size settings for a configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/request-body", "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)." } ] }, "docs": "__All products__ Return request body inspection limit settings for a configuration. Contact your account team if you'd like to run this operation." }, { "info": { "name": "Modify request body inspection limit settings for a configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/advanced-settings/request-body", "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__ Modify request body inspection limit settings for a configuration. Inspect request bodies up to a certain size. In exceptional cases, you can change the default value to a set limit: `8`, `16`, or `32` kb. Contact your account team if you'd like to run this operation." } ] }, { "info": { "name": "Behavioral DDoS profiles", "type": "folder" }, "items": [ { "info": { "name": "List Behavioral DDoS profiles", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/behavioral-ddos", "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)." } ] }, "docs": "Returns all Behavioral DDoS profiles for a specific security configuration version. _Products:_ All." }, { "info": { "name": "Create a Behavioral DDoS profile", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/behavioral-ddos", "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": "Creates a new Behavioral DDoS profile for a specific configuration version. _Products:_ All." }, { "info": { "name": "Remove a Behavioral DDoS profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/behavioral-ddos/:profileId", "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": "profileId", "value": "", "type": "path", "description": "A unique identifier for each Behavioral DDoS profile." }, { "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": "Deletes the specified Behavioral DDoS profile. You can't delete a Behavioral DDoS profile that's actively in use. To delete an active Behavioral DDoS profile, either activate an older configuration version or create a new version without the policy in place. _Products:_ All." } ] }, { "info": { "name": "Behavioral DDoS protection profiles", "type": "folder" }, "items": [ { "info": { "name": "Get a Behavioral DDoS profile", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/behavioral-ddos/:profileId", "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": "profileId", "value": "", "type": "path", "description": "A unique identifier for each Behavioral DDoS profile." }, { "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": "Returns the specified Behavioral DDoS profile. _Products:_ All." }, { "info": { "name": "Modify a Behavioral DDoS profile", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/behavioral-ddos/:profileId", "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": "profileId", "value": "", "type": "path", "description": "A unique identifier for each Behavioral DDoS profile." }, { "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": "Updates the specified Behavioral DDoS profile. _Products:_ All." } ] }, { "info": { "name": "Bypass network lists", "type": "folder" }, "items": [ { "info": { "name": "Get bypass network lists settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/bypass-network-lists", "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)." } ] }, "docs": "__Web Application Protector__ Lists which network lists are used in the bypass network lists settings. If you want to add or remove IP addresses from the network lists, use the [Network Lists API](https://techdocs.akamai.com/network-lists/reference/api)." }, { "info": { "name": "Modify the bypass network lists settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/bypass-network-lists", "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": "__Web Application Protector__ Update which network lists to use in the bypass network lists settings. If you want to add or remove IP addresses from the network lists, use the [Network Lists API](https://techdocs.akamai.com/network-lists/reference/api)." }, { "info": { "name": "Get the bypass network lists settings for a security policy", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/bypass-network-lists", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Web Application Protector__, __App & API Protector__ Lists which network lists are used in the bypass network lists settings. If you want to add or remove IP addresses from the network lists, use the [Network Lists API](https://techdocs.akamai.com/network-lists/reference/api)." }, { "info": { "name": "Modify the bypass network lists settings for a security policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/bypass-network-lists", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Web Application Protector__, __App & API Protector__ Update which network lists to use in the bypass network lists settings. If you want to add or remove IP addresses from the network lists, use the [Network Lists API](https://techdocs.akamai.com/network-lists/reference/api)." } ] }, { "info": { "name": "Shared resources: Custom deny actions", "type": "folder" }, "items": [ { "info": { "name": "List custom deny actions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/custom-deny", "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": "search", "value": "", "type": "query", "description": "Filter results by name, description, or ID. You can match on substrings." }, { "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 custom deny actions for a specific security configuration version." }, { "info": { "name": "Create a custom deny action", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/custom-deny", "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__ Create a new custom deny action for a specific configuration version." }, { "info": { "name": "Get a custom deny action", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/custom-deny/:customDenyId", "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": "customDenyId", "value": "", "type": "path", "description": "A unique identifier for each custom deny action." }, { "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 specified custom deny action." }, { "info": { "name": "Modify a custom deny action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/custom-deny/:customDenyId", "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": "customDenyId", "value": "", "type": "path", "description": "A unique identifier for each custom deny action." }, { "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__ Update details for a specific custom deny action." }, { "info": { "name": "Remove a custom deny action", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/custom-deny/:customDenyId", "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": "customDenyId", "value": "", "type": "path", "description": "A unique identifier for each custom deny action." }, { "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__ Delete a custom deny action. You can't delete a custom deny action that is actively in use. To delete the custom deny action, first activate an older configuration version or create a new version without the policy in place." } ] }, { "info": { "name": "Configuration version export", "type": "folder" }, "items": [ { "info": { "name": "Asynchronously export a configuration version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/export", "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)." } ] }, "docs": "__All products__ Start an asynchronous export of a security configuration version. The response contains an `exportId` you can use to monitor progress and get the export data once it's ready." }, { "info": { "name": "Get asynchronous export results", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/export/:exportId/result", "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": "exportId", "value": "", "type": "path", "description": "A unique identifier for each asynchronous export." }, { "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__ Get a security configuration version's export data from a previously completed asynchronous task. This is only available when the task status is `COMPLETED`." }, { "info": { "name": "Get asynchronous export status", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/export/:exportId/status", "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": "exportId", "value": "", "type": "path", "description": "A unique identifier for each asynchronous export." }, { "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__ Get a security configuration version's export status. When `PENDING`, the task is still running. When `COMPLETED`, the task finished successfully and you can collect the results through the link in the response. A status of `FAILED` appears when the task can't complete." }, { "info": { "name": "Export a configuration version", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/export/configs/:configId/versions/:versionNumber", "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)." } ] }, "docs": "__All products__ Returns comprehensive details about a security configuration version. This operation returns more data than [Get configuration version details](https://techdocs.akamai.com/application-security/reference/get-version-number), including Bot Manager protections, rate and security policies, rules, hostnames, and numerous additional settings." } ] }, { "info": { "name": "Match targets", "type": "folder" }, "items": [ { "info": { "name": "Get the hostname coverage match targets", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/hostname-coverage/match-targets", "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": "hostname", "value": "", "type": "query", "description": "Get results by hostname." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the API and website match targets that protect a hostname." }, { "info": { "name": "List match targets", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets", "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": "policyId", "value": "", "type": "query", "description": "Specifies the security policy to filter match targets." }, { "name": "includeChildObjectName", "value": "", "type": "query", "description": "Specify whether to return the object name in the payload, true` by default." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns match targets defined in the specified security configuration version." }, { "info": { "name": "Create a match target", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets", "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Creates a new Match Target in the specified Configuration Version." }, { "info": { "name": "Modify match target order", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets/sequence", "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Updates the sequence of Match Targets in a configuration version. The `website` and `api` match targets' sequence requires updates from separate requests by passing the `type` attribute in the JSON request." }, { "info": { "name": "Get a match target", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets/:targetId", "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": "targetId", "value": "", "type": "path", "description": "A unique identifier for each match target." }, { "name": "includeChildObjectName", "value": "", "type": "query", "description": "Specify whether to return the object name in the payload, true` by default." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns the specified match target." }, { "info": { "name": "Modify a match target", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets/:targetId", "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": "targetId", "value": "", "type": "path", "description": "A unique identifier for each match target." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Updates details about the specified match target." }, { "info": { "name": "Remove a match target", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/match-targets/:targetId", "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": "targetId", "value": "", "type": "path", "description": "A unique identifier for each match target." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Deletes the specified match target." } ] }, { "info": { "name": "Hostnames", "type": "folder" }, "items": [ { "info": { "name": "List hostname overlaps", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/hostname-coverage/overlapping", "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": "hostname", "value": "", "type": "query", "description": "Get results by hostname." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the configuration versions that contain a hostname also included in the current configuration version." }, { "info": { "name": "List selected hostnames for a security policy", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/selected-hostnames", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Web Application Protector__, __App & API Protector__ List the hostnames that the configuration version selects as candidates of protected hostnames, which you can use in match targets." }, { "info": { "name": "Modify selected hostnames for a security policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/selected-hostnames", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Web Application Protector__, __App & API Protector__ Update the list of selected hostnames for a configuration. You can add an individual hostname to your selected hostnames list without passing the entire list plus the new hostname in this PUT object. Previously, you needed to pass every hostname in the PUT object or any hostnames not included would be deleted from the list." }, { "info": { "name": "List selectable hostnames", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/selectable-hostnames", "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)." } ] }, "docs": "__All products__ List the hostnames that a given configuration version has the ability to protect. Hostnames may show as error hosts when they aren't currently available. For example, when a contract expires." }, { "info": { "name": "List selected hostnames", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/selected-hostnames", "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)." } ] }, "docs": "__All products__ List the hostnames that the configuration version selects as candidates of protected hostnames, which you can use in match targets." }, { "info": { "name": "Modify selected hostnames", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/selected-hostnames", "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__ Update the list of selected hostnames for a configuration version. Now you can add an individual hostname to your selected hostnames list without passing the entire list plus the new hostname in this PUT object. Previously, you needed to pass every hostname in the PUT object or any hostnames not included would be deleted from the list." } ] }, { "info": { "name": "Shared resources: Malware policies", "type": "folder" }, "items": [ { "info": { "name": "List malware policies", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/malware-policies", "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)." } ] }, "docs": "__All products__ Return malware policies for a security configuration version." }, { "info": { "name": "Create a malware policy", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/malware-policies", "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__ Create a new malware policy for a security configuration version." }, { "info": { "name": "List supported malware policy content types", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/malware-policies/content-types", "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)." } ] }, "docs": "__All products__ Returns all the supported malware policy content types for a security configuration version." }, { "info": { "name": "Get a malware policy", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/malware-policies/:malwarePolicyId", "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": "malwarePolicyId", "value": "", "type": "path", "description": "A unique identifier for each malware policy." }, { "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__ Return a malware policy." }, { "info": { "name": "Modify a malware policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/malware-policies/:malwarePolicyId", "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": "malwarePolicyId", "value": "", "type": "path", "description": "A unique identifier for each malware policy." }, { "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__ Update details for a malware policy." }, { "info": { "name": "Remove a malware policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/malware-policies/:malwarePolicyId", "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": "malwarePolicyId", "value": "", "type": "path", "description": "A unique identifier for each malware policy." }, { "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__ Delete a specific malware policy that's not actively in use. To delete an active malware policy, first activate an older configuration version or create a new version without the policy in place." } ] }, { "info": { "name": "Configuration: Evaluation hostnames", "type": "folder" }, "items": [ { "info": { "name": "Protect evaluation hostnames", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/protect-eval-hostnames", "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": "__Web Application Protector__, __App & API Protector__ Move hostnames you're evaluating to active protection. When you move a hostname from the evaluation hostnames list, it's added to your security policy as a protected hostname. You'll see that hostname in the response object the next time you run [List selected hostnames](https://techdocs.akamai.com/application-security/reference/get-selected-hostnames)." }, { "info": { "name": "List evaluation hostnames", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/selected-hostnames/eval-hostnames", "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)." } ] }, "docs": "__Web Application Protector__, __App & API Protector__ List the evaluation hostnames for a configuration version. Evaluation mode for hostnames is only available for Web Application Protector and App & API Protector. Run hostnames in evaluation mode to see how your configuration settings protect traffic for that hostname before adding a hostname directly to a live configuration. Once you begin, the hostnames you evaluate start responding to traffic as if they are your current hostnames. However," }, { "info": { "name": "Modify evaluation hostnames", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/selected-hostnames/eval-hostnames", "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": "__Web Application Protector__, __App & API Protector__ Update the list of hostnames you want to evaluate for a configuration version." } ] }, { "info": { "name": "Shared resources: Rate policies", "type": "folder" }, "items": [ { "info": { "name": "List rate policies", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/rate-policies", "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)." } ] }, "docs": "__All products__ Returns rate policies for a specific security configuration version." }, { "info": { "name": "Create a rate policy", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/rate-policies", "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__ Create a new rate policy for a specific configuration version. Now you can match on defined or undefined resources. If you're setting a match for either resource type, both `definedResources` and `undefinedResources` must be present in the request object or the request is considered incomplete. When `true`, match on _any_ defined resources without passing a `resourceId`. When `false`, you'll need to pass a `resourceId`. If you pass `definedResources` and `undefinedResources` wit" }, { "info": { "name": "Get a rate policy", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/rate-policies/:ratePolicyId", "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": "ratePolicyId", "value": "", "type": "path", "description": "A unique identifier for each rate policy." }, { "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 specified rate policy." }, { "info": { "name": "Modify a rate policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/rate-policies/:ratePolicyId", "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": "ratePolicyId", "value": "", "type": "path", "description": "A unique identifier for each rate policy." }, { "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__ Update details for a specific rate policy. Now you can match on defined or undefined resources. If you're setting a match for either resource type, both `definedResources` and `undefinedResources` must be present in the request object or the request is considered incomplete. When `true`, match on _any_ defined resources without passing a `resourceId`. When `false`, you'll need to pass a `resourceId`. If you pass `definedResources` and `undefinedResources` with empty values, they" }, { "info": { "name": "Remove a rate policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/rate-policies/:ratePolicyId", "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": "ratePolicyId", "value": "", "type": "path", "description": "A unique identifier for each rate policy." }, { "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__ Delete the specified rate policy. You can't delete a rate policy that is actively in use. To delete the rate policy, first activate an older configuration version or create a new version without the policy in place." }, { "info": { "name": "Modify a rate policy evaluation", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/rate-policies/:ratePolicyId/evaluation", "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": "ratePolicyId", "value": "", "type": "path", "description": "A unique identifier for each rate policy." }, { "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__ Apply or discard a rate policy evaluation." } ] }, { "info": { "name": "Shared resources: Reputation profiles", "type": "folder" }, "items": [ { "info": { "name": "List reputation profiles", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/reputation-profiles", "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)." } ] }, "docs": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns reputation profiles for a specific security configuration version. To use reputation profiles, you need to add [Client Reputation](https://techdocs.akamai.com/app-api-protector/docs/control-client-reputation) to Kona Site Defender on your contract." }, { "info": { "name": "Create a reputation profile", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/reputation-profiles", "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Create a new reputation profile for a specific configuration version." }, { "info": { "name": "Get a reputation profile", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/reputation-profiles/:reputationProfileId", "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": "reputationProfileId", "value": "", "type": "path", "description": "A unique identifier for each reputation profile." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns the details for a specific reputation profile." }, { "info": { "name": "Modify a reputation profile", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/reputation-profiles/:reputationProfileId", "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": "reputationProfileId", "value": "", "type": "path", "description": "A unique identifier for each reputation profile." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update details for a specific reputation profile." }, { "info": { "name": "Remove a reputation profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/reputation-profiles/:reputationProfileId", "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": "reputationProfileId", "value": "", "type": "path", "description": "A unique identifier for each reputation profile." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Delete a reputation profile. You can't delete a reputation profile that is actively in use. To delete the reputation profile, first activate an older configuration version or create a new version without that policy in place." } ] }, { "info": { "name": "Challenge actions", "type": "folder" }, "items": [ { "info": { "name": "List challenge actions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/response-actions/challenge-actions", "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)." } ] }, "docs": "List all of your challenge actions along with their names, challenge types, and other summary information." }, { "info": { "name": "Create a challenge action", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/response-actions/challenge-actions", "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": "Create a new challenge action. Use this action type to insert a challenge, like a CAPTCHA, into the user workflow. You can also apply your own branding to the action to match your website. See [Challenge actions](https://techdocs.akamai.com/app-api-protector/docs/challenge-actions) for more details." }, { "info": { "name": "Get a challenge action", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId", "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": "actionId", "value": "", "type": "path", "description": "Identifies the action." }, { "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": "View details about the specified challenge action." }, { "info": { "name": "Update a challenge action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId", "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": "actionId", "value": "", "type": "path", "description": "Identifies the action." }, { "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": "Edit the specified challenge action, such as the name, type of challenge, or branding." }, { "info": { "name": "Delete a challenge action", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId", "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": "actionId", "value": "", "type": "path", "description": "Identifies the action." }, { "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": "Remove the specified challenge action." }, { "info": { "name": "Update Google reCAPTCHA secret key", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/response-actions/challenge-actions/:actionId/google-recaptcha-secret-key", "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": "actionId", "value": "", "type": "path", "description": "Identifies the action." }, { "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": "Specify a different Google reCAPTCHA secret key for a challenge action. The secret key authorizes communication between your site and the reCAPTCHA server." } ] }, { "info": { "name": "General policy settings", "type": "folder" }, "items": [ { "info": { "name": "List security policies", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies", "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": "notMatched", "value": "", "type": "query", "description": "If `true`, returns all security policies in the configuration version that don't have a match target. If `false`, returns all security policies in the configuration version." }, { "name": "detail", "value": "", "type": "query", "description": "When `true`, the results contain detailed information on versions. With the default `false`, the results contain summary information on versions." }, { "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 a list of security policies available for the specified security configuration." }, { "info": { "name": "Clone or create a security policy", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies", "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Creates a new copy of an existing security policy or creates a new security policy from scratch when you don't specify a policy to clone in the request. To create a new security policy, leave `createFromSecurityPolicy` empty in your request." }, { "info": { "name": "Get a security policy", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 specified security policy." }, { "info": { "name": "Modify a security policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Update the name of a specific security policy. Currently, you can only edit a security policy's name with this operation, although other editable fields will be available in the future. For any changes to settings within a security policy, run the modify operation for that specific setting. For example, to update your IP/Geo settings, run [Update IP/Geo Firewall settings](https://techdocs.akamai.com/application-security/reference/put-policy-ip-geo-firewall)." }, { "info": { "name": "Remove a security policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Delete the specified security policy. You can't delete a security policy that is actively in use. Before you run this operation, create a new version of your security configuration and omit the policy you want to delete. Once you have activated your new configuration version, you can delete the security policy you omitted from the new version. One way to create a new configuration quickly is to run [Clone a configu" } ] }, { "info": { "name": "Request body inspection limits", "type": "folder" }, "items": [ { "info": { "name": "Get request body inspection limit settings for a security policy", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/request-body", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Return request body inspection limit settings for a security policy. Contact your account team if you'd like to run this operation." }, { "info": { "name": "Modify request body size settings for a security policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/advanced-settings/request-body", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Update inspection settings for a security policy. Inspect request bodies up to a certain size. In exceptional cases, you can change the default value to a set limit: `8`, `16`, or `32` KB. Contact your account team if you'd like to run this operation." } ] }, { "info": { "name": "API endpoints", "type": "folder" }, "items": [ { "info": { "name": "List API endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/api-endpoints", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the API endpoints associated with a security policy. This operation only lists the endpoints. To manage them, use [Register an endpoint](https://techdocs.akamai.com/api-gateway/reference/post-endpoints) from the API Endpoint Definition API." } ] }, { "info": { "name": "API request constraints", "type": "folder" }, "items": [ { "info": { "name": "List API request constraints and actions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/api-request-constraints", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return a list of APIs with their constraints and associated actions." }, { "info": { "name": "Modify the request constraint action for all APIs", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/api-request-constraints", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action to take when any API request constraint triggers. Use `alert` to record the trigger of the event, `deny` to block the request, or `customDenyId` to apply a custom deny response." }, { "info": { "name": "Modify an API request constraint's action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/api-request-constraints/:apiId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "apiId", "value": "", "type": "path", "description": "A unique identifier for each API." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action to take when the API request constraint triggers. This operation modifies an individual API constraint action. To use this operation, run [List all API request constraints and actions](https://techdocs.akamai.com/application-security/reference/get-api-request-constraints) and pick an API from the response list. Use `alert` to record the trigger of the event, `deny` to block the request, or `none`" } ] }, { "info": { "name": "WAF rules: Attack groups", "type": "folder" }, "items": [ { "info": { "name": "List attack groups", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/attack-groups", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Return a list of attack groups with their associated actions." }, { "info": { "name": "Get the action for an attack group", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/attack-groups/:attackGroupId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "attackGroupId", "value": "", "type": "path", "description": "A unique identifier for each attack group." }, { "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__ Currently the only field in the response object is `action`, which displays the action for the attack group." }, { "info": { "name": "Modify the action for an attack group", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/attack-groups/:attackGroupId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "attackGroupId", "value": "", "type": "path", "description": "A unique identifier for each attack group." }, { "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__ Update what action to take when an attack group's rule triggers. Use `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action. Currently the only field in the attack group object is `action`." }, { "info": { "name": "Get the exceptions of an attack group", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/attack-groups/:attackGroupId/condition-exception", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "attackGroupId", "value": "", "type": "path", "description": "A unique identifier for each attack group." }, { "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__ List an attack group's exceptions." }, { "info": { "name": "Modify the exceptions of an attack group", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/attack-groups/:attackGroupId/condition-exception", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "attackGroupId", "value": "", "type": "path", "description": "A unique identifier for each attack group." }, { "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__ Update an attack group exceptions." } ] }, { "info": { "name": "Behavioral DDoS profile actions", "type": "folder" }, "items": [ { "info": { "name": "List Behavioral DDoS profile actions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/behavioral-ddos", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "Returns a list of all Behavioral DDoS profiles currently in use, along with the actions each profile takes when conditions are met. _Products:_ All." }, { "info": { "name": "Modify a Behavioral DDoS profile action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/behavioral-ddos/:profileId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "profileId", "value": "", "type": "path", "description": "A unique identifier for each Behavioral DDoS profile." }, { "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": "Updates the actions in a Behavioral DDoS profile. _Products:_ All." } ] }, { "info": { "name": "Client-Side Protections & Compliance", "type": "folder" }, "items": [ { "info": { "name": "Get Client-Side Protection & Compliance settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/cpc", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Get Client-Side Protection & Compliance settings for a specific policy. For more information, see [Client-side Protection & Compliance](https://techdocs.akamai.com/client-side-protect-compliance/docs/client-side-protect-compliance-ov)" }, { "info": { "name": "Modify Client-Side Protections & Compliance settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/cpc", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Update Client-Side Protection & Compliance settings for a specific policy." } ] }, { "info": { "name": "Custom rule actions", "type": "folder" }, "items": [ { "info": { "name": "List custom rule actions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/custom-rules", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 a list of all configured custom rules for the specified configuration. It includes information for rules that are associated with this policy, as well as the latest versions of the rules in the configuration that aren't associated with the current policy. Unassociated rules have an action of `none`." }, { "info": { "name": "Modify a custom rule action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/custom-rules/:ruleId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "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 the action of a custom rule." } ] }, { "info": { "name": "Security policy: Evaluation mode", "type": "folder" }, "items": [ { "info": { "name": "Set evaluation mode", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Evaluation mode runs concurrently with your existing Web Application Firewall Rule settings and records how the rules would respond if they were applied to live traffic. The default action for evaluation rules is `alert`. Unlike other POST or PUT actions, this request object supports values other than `enabled` or `disabled`. Use `START` to begin evaluation mode. An evaluation period lasts four weeks unless you sto" } ] }, { "info": { "name": "Security policy: Evaluation attack groups", "type": "folder" }, "items": [ { "info": { "name": "List evaluation attack groups", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-groups", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Return a list of evaluation attack groups with their associated actions." }, { "info": { "name": "Get the action for an evaluation attack group", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-groups/:attackGroupId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "attackGroupId", "value": "", "type": "path", "description": "A unique identifier for each attack group." }, { "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__ Currently the only field in the response object is `action`, which displays the action for the evaluation attack group." }, { "info": { "name": "Modify the action for an evaluation attack group", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-groups/:attackGroupId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "attackGroupId", "value": "", "type": "path", "description": "A unique identifier for each attack group." }, { "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__ Update what action to take when an evaluation attack group's rule triggers. Use `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action. Currently the only field in the attack group object is `action`." } ] }, { "info": { "name": "Security policy: Conditions and exceptions", "type": "folder" }, "items": [ { "info": { "name": "Get the exceptions of an evaluation attack group", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-groups/:attackGroupId/condition-exception", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "attackGroupId", "value": "", "type": "path", "description": "A unique identifier for each attack group." }, { "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__ List an attack group's exceptions." }, { "info": { "name": "Modify the exceptions of an evaluation attack group", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-groups/:attackGroupId/condition-exception", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "attackGroupId", "value": "", "type": "path", "description": "A unique identifier for each attack group." }, { "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__ Update an evaluation attack group exceptions." }, { "info": { "name": "Get the conditions and exceptions for an evaluation rule", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-rules/:ruleId/condition-exception", "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "name": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List the conditions and exceptions for a rule you want to evaluate. This operation returns the same object type as other condition and exception operations. Keep in mind that the response for this operation applies to the rules you're evaluating even though the concept of conditions and exceptions is the same for all condition exception endpoints." }, { "info": { "name": "Modify the conditions and exceptions for an evaluation rule", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-rules/:ruleId/condition-exception", "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "name": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update an evaluation rule's conditions and exceptions. When the conditions are met, the rule's actions are ignored and not applied to that specific traffic. The rule action you update with this operation is for a rule you are evaluating and not a rule currently in use for your site or app." } ] }, { "info": { "name": "Security policy: Evaluation hostnames", "type": "folder" }, "items": [ { "info": { "name": "List evaluation hostnames for a security policy", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-hostnames", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Web Application Protector__, __App & API Protector__ List the evaluation hostnames for a configuration version. Evaluation mode for hostnames is only available for Web Application Protector. Run hostnames in evaluation mode to see how your configuration settings protect traffic for that hostname before adding a hostname directly to a live configuration. Once you begin, the hostnames you evaluate start responding to traffic as if they are your current hostnames. However, instead of taking an ac" }, { "info": { "name": "Modify evaluation hostnames for a security policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-hostnames", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Web Application Protector__, __App & API Protector__ Update the list of hostnames you want to evaluate for a configuration version." }, { "info": { "name": "Protect evaluation hostnames for a security policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/protect-eval-hostnames", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Web Application Protector__, __App & API Protector__ Move hostnames you're evaluating to active protection. When you move a hostname from the evaluation hostnames list, it's added to your security policy as a protected hostname. You'll see that hostname in the response object the next time you run [List selected hostnames](https://techdocs.akamai.com/application-security/reference/get-selected-hostnames)." } ] }, { "info": { "name": "Security policy: Evaluation penalty box", "type": "folder" }, "items": [ { "info": { "name": "Get the penalty box for a policy in evaluation mode", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-penalty-box", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 penalty box settings for a security policy in evaluation mode. When the penalty box is enabled for a policy, clients that trigger a Web Application Firewall deny action are placed in the penalty box. There, the action you select for penalty box (either `alert` or `deny`) continues to apply to any requests from that client for the next 10 minutes." }, { "info": { "name": "Modify the evaluation penalty box", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-penalty-box", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Update the penalty box settings for a security policy in evaluation mode. If set to `true`, you can choose to `deny` requests coming from a client in the penalty box, or trigger an `alert` instead." } ] }, { "info": { "name": "WAF rules: Evaluation Penalty box conditions", "type": "folder" }, "items": [ { "info": { "name": "Get penalty box conditions in evaluation mode", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-penalty-box/conditions", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 penalty box condition settings for a security policy in evaluation mode." }, { "info": { "name": "Modify the penalty box conditions in evaluation mode", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-penalty-box/conditions", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Modifies the penalty box condition settings for a security policy in evaluation mode." } ] }, { "info": { "name": "Security policy: Evaluation rules", "type": "folder" }, "items": [ { "info": { "name": "List evaluation rules", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-rules", "params": [ { "name": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the rules available for evaluation and their actions." }, { "info": { "name": "Get the action of an evaluation rule", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-rules/:ruleId", "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "name": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the action for a specific rule you want to evaluate. This applies to both ASE auto and ASE manual upgrade modes. You may need additional permissions to add or update rule actions in `ASE_AUTO` mode." }, { "info": { "name": "Modify the action of an evaluation rule", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/eval-rules/:ruleId", "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "name": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "versionNumber", "value": "", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update the action for a specific rule you want to evaluate. Like your current rules, actions are `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action. This applies to both ASE auto and ASE manual upgrade modes. You may need additional permissions to add or update rule actions in `ASE_AUTO` mode." } ] }, { "info": { "name": "IP/Geo Firewall settings", "type": "folder" }, "items": [ { "info": { "name": "Get IP/Geo Firewall settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/ip-geo-firewall", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 which network lists are used in the IP/Geo Firewall settings. In Control Center this method is called `mode`. In this API the method is called `blocked`. The response shows blocked and allowed IPs depending on which network lists you include and which version of the mode you choose. If you want to add or remove IP addresses from the network lists, use the [Network Lists API](https://techdocs.akamai.com/network-lists/reference/api). Note that subnet controls are a legacy it" }, { "info": { "name": "Modify IP/Geo Firewall settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/ip-geo-firewall", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Update the method and which network lists to use for IP/Geo firewall blocking. In Control Center this method is called `mode`. In this API the method is called `blocked`. Use `blockSpecificIPGeo` to block any IPs, geographies, or network lists you choose with this setting. Use `blockAllTrafficExceptAllowedIPs` to allow specific IPs or geographies that you choose to let through while the rest remain blocked. IPs you want to allow are contained in the `allowedIPNetworkLists`. It's" } ] }, { "info": { "name": "Malware policy actions", "type": "folder" }, "items": [ { "info": { "name": "List malware policy actions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/malware-policies", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Return a list of all malware policies currently in use with the actions each policy takes when conditions are met." }, { "info": { "name": "Modify a malware policy action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/malware-policies/:malwarePolicyId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "malwarePolicyId", "value": "", "type": "path", "description": "A unique identifier for each malware policy." }, { "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__ Update the actions in a malware policy." } ] }, { "info": { "name": "WAF rules: Update mode", "type": "folder" }, "items": [ { "info": { "name": "Get the current mode", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/mode", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ When using Web Application Firewall in your security policy, this mode conveys how you're planning to keep the rules up to date, either `KRS` for manual updates or `AAG` for automatic updates. This operation returns which mode your rules are currently set to." }, { "info": { "name": "Modify the mode", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/mode", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__, __Adaptive Security Engine__ The mode you set determines how your rule sets are updated. Use `KRS` mode to update the rule sets manually, or `AAG` to have them update automatically. If you're using Adaptive Security Engine, use `ASE_AUTO` to update the rules automatically, or `ASE_MANUAL` to update them yourself." } ] }, { "info": { "name": "WAF rules: Penalty box", "type": "folder" }, "items": [ { "info": { "name": "Get the penalty box", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/penalty-box", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 penalty box settings for the security policy you specify." }, { "info": { "name": "Modify the penalty box", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/penalty-box", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Modifies the penalty box settings for a security policy. When the penalty box is enabled for a policy, clients that trigger a WAF Deny action are placed in the _penalty box_. There, the action you select for penalty box (either `Alert` or `Deny`) continues to apply to any requests from that client for the next 10 minutes." } ] }, { "info": { "name": "WAF rules: Penalty box conditions", "type": "folder" }, "items": [ { "info": { "name": "Get penalty box condition", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/penalty-box/conditions", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 penalty box condition settings for a security policy." }, { "info": { "name": "Modify the penalty box conditions", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/penalty-box/conditions", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Modifies the penalty box conditions settings for a security policy." } ] }, { "info": { "name": "Protections", "type": "folder" }, "items": [ { "info": { "name": "Get protections", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/protections", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Get the protections and whether they are enabled or disabled in a security policy." }, { "info": { "name": "Modify protections", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/protections", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Update the security policy protections. This applies a set of protections that you can enable individually." } ] }, { "info": { "name": "WAF rules: Rapid rules", "type": "folder" }, "items": [ { "info": { "name": "List rapid rules", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 rapid rules. [Rapid rules](https://techdocs.akamai.com/app-api-protector/docs/rapid-rules) are WAF rules we are actively testing and refining. You can start using them while we revise them. Once we complete fine-tuning a rule, it becomes a WAF rule you can access through [List rules](https://techdocs.akamai.com/application-security/docs/get-policy-rules)." }, { "info": { "name": "Get rapid rules' default action", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/action", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 default action set for all rapid rules. To override this setting for an individual rule, run [Update a rapid rule's action](https://techdocs.akamai.com/application-security/docs/put-policy-rapid-rule-action)." }, { "info": { "name": "Update rapid rules' default action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/action", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Set rapid rules default action. This applies to _all_ rapid rules by default unless you specifically override this setting for an individual rule with [Update a rapid rule's action](https://techdocs.akamai.com/application-security/docs/put-policy-rapid-rule-action)." }, { "info": { "name": "Get rapid rules' status", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/status", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 whether rapid rules are enabled or disabled." }, { "info": { "name": "Update rapid rules' status", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/status", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Enable or disable all rapid rules." }, { "info": { "name": "List a rapid rule's conditions and exceptions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/condition-exception", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "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 conditions and exceptions set for the rapid rule." }, { "info": { "name": "Update a rapid rule's conditions and exceptions", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/condition-exception", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "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__ Set the rapid rule's conditions and exceptions." }, { "info": { "name": "Get a rapid rule's lock status", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/lock", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "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 rapid rule lock status. When locked, the action set for the rapid rule applies to all new versions of that rule." }, { "info": { "name": "Update a rapid rule's lock status", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/lock", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "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__ Set the rapid rule lock status. When enabled, the action set for the rapid rule applies to all new versions of that rule." }, { "info": { "name": "Get a rapid rule's action", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/versions/:ruleVersion/action", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "name": "ruleVersion", "value": "", "type": "path", "description": "A unique identifier for each version of a rapid rule." }, { "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 action for a single rapid rule. Run [Update a rapid rule's action](https://techdocs.akamai.com/application-security/docs/put-policy-rapid-rule-action) if you want to set different actions for each rule, or override the default action for a single rule." }, { "info": { "name": "Update a rapid rule's action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/versions/:ruleVersion/action", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "name": "ruleVersion", "value": "", "type": "path", "description": "A unique identifier for each version of a rapid rule." }, { "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__ Set the rapid rule's action. Run this operation if you want to set different actions for each rule, or override the default action for a single rule." } ] }, { "info": { "name": "Rate policy actions", "type": "folder" }, "items": [ { "info": { "name": "List rate policy actions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rate-policies", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 a list of all rate policies currently in use with the actions each policy takes when conditions are met." }, { "info": { "name": "Modify a rate policy action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rate-policies/:ratePolicyId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ratePolicyId", "value": "", "type": "path", "description": "A unique identifier for each rate policy." }, { "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 the actions in a rate policy." } ] }, { "info": { "name": "WAF rules: Tuning recommendations", "type": "folder" }, "items": [ { "info": { "name": "Get tuning recommendations for a policy", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "type", "value": "", "type": "query", "description": "__Enum__ If `ACTIVE`, includes only active recommendations, the default. If `EVALUATION`, includes only evaluation recommendations. If `ALL`, includes both active and evaluation recommendations." }, { "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": "__Adaptive Security Engine__ Lists available tuning recommendations for a policy. Our system can identify patterns of false positives, and suggests exceptions for you to include in your policy." }, { "info": { "name": "Respond to exception recommendations", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "type", "value": "", "type": "query", "description": "__Enum__ If `ACTIVE`, includes only active recommendations, the default. If `EVALUATION`, includes only evaluation recommendations. If `ALL`, includes both active and evaluation recommendations." }, { "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": "__Adaptive Security Engine__ Accept, decline, or reset the recommended exception. Accepting a tuning recommendation creates or updates the exception for the attack group. Use `reset` to restore a declined recommendation to a neutral state so you can accept it or decline it again later." }, { "info": { "name": "List tuning recommendations for an attack group", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations/attack-groups/:attackGroupId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "attackGroupId", "value": "", "type": "path", "description": "A unique identifier for each attack group." }, { "name": "type", "value": "", "type": "query", "description": "__Enum__ If `ACTIVE`, includes only active recommendations, the default. If `EVALUATION`, includes only evaluation recommendations. If `ALL`, includes both active and evaluation recommendations." }, { "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": "__Adaptive Security Engine__ Returns available tuning recommendations for an attack group. Our system can identify patterns of false positives, and suggests exceptions for you to include in your attack group." }, { "info": { "name": "List tuning recommendations for a rule", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/recommendations/rules/:ruleId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "name": "type", "value": "", "type": "query", "description": "__Enum__ If `ACTIVE`, includes only active recommendations, the default. If `EVALUATION`, includes only evaluation recommendations. If `ALL`, includes both active and evaluation recommendations." }, { "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": "__Adaptive Security Engine__ Returns available tuning recommendations for a rule. Our system can identify patterns of false positives, and suggests exceptions for you to include in your rule. In cases where your rules are already optimum, the response payload returns empty." } ] }, { "info": { "name": "Reputation analysis", "type": "folder" }, "items": [ { "info": { "name": "Get reputation analysis settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/reputation-analysis", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Kona Site Defender__ Return the current reputation analysis settings." }, { "info": { "name": "Modify reputation analysis settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/reputation-analysis", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Kona Site Defender__ Toggle the `forwardToHTTPHeader` and `forwardSharedIPToHTTPHeaderAndSIEM` options. The `forwardToHTTPHeader` option adds client reputation details to requests forwarded to origin in an HTTP header. The `forwardSharedIPToHTTPHeaderAndSIEM` option adds a value indicating that shared IPs are included in HTTP header and SIEM integration when used." } ] }, { "info": { "name": "Client reputation", "type": "folder" }, "items": [ { "info": { "name": "List reputation profile actions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/reputation-profiles", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return a list of reputation profiles with their associated actions." }, { "info": { "name": "Get the action for a reputation profile", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/reputation-profiles/:reputationProfileId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "reputationProfileId", "value": "", "type": "path", "description": "A unique identifier for each reputation profile." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the action a reputation profile takes when triggered." }, { "info": { "name": "Modify the action for a reputation profile", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/reputation-profiles/:reputationProfileId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "reputationProfileId", "value": "", "type": "path", "description": "A unique identifier for each reputation profile." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action to take when reputation profile's rule triggers. Use `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action. Currently the only field in the reputation profile object is `action`." } ] }, { "info": { "name": "WAF rules: General settings", "type": "folder" }, "items": [ { "info": { "name": "List rules", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Returns the action taken for each rule in a policy. The action occurs when the rules are triggered by a request. These are not the same rules as Custom Rules that you configure yourself. These rules are maintained by Akamai." }, { "info": { "name": "Upgrade KRS ruleset", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__, __Adaptive Security Engine__ Upgrade to the most recent version of the KRS rule set. Akamai periodically updates these rules to keep protections current. However, the rules you use in your security policies do not automatically upgrade to the latest version when setting `mode` to `KRS`. These rules do update automatically when you have `mode` set to `AAG`. Before you upgrade, run [Get upgrade details](https://tech" }, { "info": { "name": "Get upgrade details", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/upgrade-details", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Only applies to Kona rule sets. The KRS rule sets are maintained by Akamai's security research team. Run this operation before you upgrade to verify changes in the rule sets. If you want to test how the updates affect your site, you can run the updated rules in evaluation mode." }, { "info": { "name": "Get the action for a rule", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Return the action a rule takes when triggered. This applies to both ASE auto and ASE manual upgrade modes. Rule actions for `ASE_AUTO` are currently in beta. Contact your account team to access this option." }, { "info": { "name": "Modify the action for a rule", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update what action a rule takes when it's triggered. This applies to both ASE auto and ASE manual upgrade modes. Rule actions for `ASE_AUTO` are currently in beta. Contact your account team to access this option. Use `alert` to record the trigger of the event, `deny` to block the request, or `none` to take no action." }, { "info": { "name": "Get the conditions and exceptions of a rule", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId/condition-exception", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ List a KRS rule's conditions and exceptions." }, { "info": { "name": "Modify the conditions and exceptions of a rule", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rules/:ruleId/condition-exception", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "", "type": "path", "description": "A unique identifier for rule." }, { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Update a rule's conditions and exceptions. When the conditions are met, the rule's actions are ignored and _not_ applied to that specific traffic." }, { "info": { "name": "Get adaptive intelligence settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/threat-intel", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 whether adaptive intelligence is enabled. Adaptive intelligence allows our network to better tune rules for better accuracy. Contact your account team if you'd like to run this operation." }, { "info": { "name": "Modify adaptive intelligence settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/threat-intel", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Only applies to Adaptive Security Engine (ASE) manual rule sets. Enable or disable adaptive intelligence. Contact your account team if you'd like to run this operation." }, { "info": { "name": "Get a security policy's rule set", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/web-application-firewall/ruleset", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 security policy rule set, which includes the version, threat intelligence settings, rules, and attack group details." }, { "info": { "name": "Modify a security policy's rule set", "type": "http" }, "http": { "method": "PATCH", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/web-application-firewall/ruleset", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Modify the security policy's rule set including its rule and attack group details." } ] }, { "info": { "name": "Slow POST protections", "type": "folder" }, "items": [ { "info": { "name": "Get slow POST protection settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/slow-post", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Get slow POST protection settings for a specific policy." }, { "info": { "name": "Modify slow POST protection settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/slow-post", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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__ Update slow POST protection settings for a specific policy." } ] }, { "info": { "name": "URL protection policy actions", "type": "folder" }, "items": [ { "info": { "name": "List URL protection policy actions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/url-protections", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "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 a list of all URL protection policies currently in use, along with the actions each policy takes when conditions are met." }, { "info": { "name": "Modify a URL protection policy action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/url-protections/:urlProtectionPolicyId", "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": "policyId", "value": "", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "urlProtectionPolicyId", "value": "", "type": "path", "description": "A unique identifier for each URL protection policy." }, { "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 the actions in a URL protection policy." } ] }, { "info": { "name": "SIEM settings", "type": "folder" }, "items": [ { "info": { "name": "Get SIEM settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/siem", "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)." } ] }, "docs": "__All products__ Return SIEM settings for a specific configuration." }, { "info": { "name": "Modify SIEM settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/siem", "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__ Update SIEM settings for a specific configuration." }, { "info": { "name": "Get SIEM versions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/siem-definitions", "params": [ { "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__ Get available SIEM versions." } ] }, { "info": { "name": "URL protection policies", "type": "folder" }, "items": [ { "info": { "name": "List URL protection policies", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/url-protections", "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)." } ] }, "docs": "__All products__ Returns all URL protection policies for a specific security configuration version." }, { "info": { "name": "Create a URL protection policy", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/url-protections", "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__ Creates a new URL protection policy for a specific configuration version." }, { "info": { "name": "Get a URL protection policy", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/url-protections/:urlProtectionPolicyId", "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": "urlProtectionPolicyId", "value": "", "type": "path", "description": "A unique identifier for each URL protection policy." }, { "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 specified URL protection policy." }, { "info": { "name": "Modify a URL protection policy", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/url-protections/:urlProtectionPolicyId", "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": "urlProtectionPolicyId", "value": "", "type": "path", "description": "A unique identifier for each URL protection policy." }, { "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 the specified URL protection policy." }, { "info": { "name": "Remove a URL protection policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/url-protections/:urlProtectionPolicyId", "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": "urlProtectionPolicyId", "value": "", "type": "path", "description": "A unique identifier for each URL protection policy." }, { "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 the specified URL protection policy. You can't delete a URL protection policy that's actively in use. To delete an active URL protection policy, either activate an older configuration version or create a new version without the policy in place." } ] }, { "info": { "name": "Contracts and groups", "type": "folder" }, "items": [ { "info": { "name": "List contracts and groups", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/contracts-groups", "params": [ { "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__ List the contracts and groups for your account. Each object contains the contract, groups associated with the contract, and whether Kona Site Defender or Web Application Protector is the product for that contract. You'll need this information when you create a new security configuration or when you want to get a list of hostnames still available for use in a security policy." } ] }, { "info": { "name": "Available hostnames", "type": "folder" }, "items": [ { "info": { "name": "List available hostnames for a new configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/contracts/:contractId/groups/:groupId/selectable-hostnames", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "A unique identifier for a group." }, { "name": "contractId", "value": "", "type": "path", "description": "A unique identifier for a contract." }, { "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 the hostnames for a given contract and group. Use this operation for a new configuration, and use [List selectable hostnames](https://techdocs.akamai.com/application-security/reference/get-selectable-hostnames) to see a list of hostnames you can add to an existing configuration. This operation shows you every acceptable hostname you can use, where the other hostname operation omits any hostnames already included in your configuration." } ] }, { "info": { "name": "CVE Protections lookup", "type": "folder" }, "items": [ { "info": { "name": "List CVEs", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/cves", "params": [ { "name": "modifiedAfter", "value": "", "type": "query", "description": "Filters CVEs by `modifiedDate`, returning all CVEs modified after that time." }, { "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": "List CVEs currently in Akamai's CVE catalog. The catalog contains only CVEs the Akamai Threat Research team is aware of. App & API Protector can identify and block attacks related to the active exploitation of many more CVEs and attacks without associated known vulnerabilities." }, { "info": { "name": "Subscribe to CVEs", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/cves/subscribe", "params": [ { "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": "Subscribe to notifications for specific CVEs." }, { "info": { "name": "List subscribed CVEs", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/cves/subscribed", "params": [ { "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": "List the CVEs you are subscribed to. To add or remove CVEs, run [Subscribe to CVEs](https://techdocs.akamai.com/application-security/docs/post-subscribe) or [Unsubscribe from CVEs](https://techdocs.akamai.com/application-security/docs/post-unsubscribe) accordingly." }, { "info": { "name": "Unsubscribe from CVEs", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/cves/unsubscribe", "params": [ { "name": "all", "value": "", "type": "query", "description": "Whether to unsubscribe from all CVEs, `false` by default." }, { "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": "Unsubscribe from notifications about all CVEs, or specific CVEs." }, { "info": { "name": "Get a CVE", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/cves/:cveId", "params": [ { "name": "cveId", "value": "", "type": "path", "description": "A unique identifier for each CVE." }, { "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": "Get details for a specific CVE." }, { "info": { "name": "Get CVE coverage", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/cves/:cveId/security-coverage", "params": [ { "name": "cveId", "value": "", "type": "path", "description": "A unique identifier for each CVE." }, { "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": "The coverages provided by your configurations, attack groups, and rules." } ] }, { "info": { "name": "Hostname coverage", "type": "folder" }, "items": [ { "info": { "name": "Get hostname coverage", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/hostname-coverage", "params": [ { "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": "__Kona Site Defender__, __App & API Protector with the Advanced Security module__ Get the list of hostnames in the account with their current protections, activation statuses, and other summary information." } ] }, { "info": { "name": "Onboarding: Creation and settings", "type": "folder" }, "items": [ { "info": { "name": "List onboardings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/onboardings", "params": [ { "name": "onboardingStatuses", "value": "", "type": "query", "description": "Lists onboardings for a specific status." }, { "name": "hostnames", "value": "", "type": "query", "description": "Returns onboardings containing the specified hostnames." }, { "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": "__App & API Protector__, __App & API Protector with the Advanced Security module__ Lists onboardings. You can filter results by hostname or onboarding status." }, { "info": { "name": "Create an onboarding", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/onboardings", "params": [ { "name": "createNewResourcesOnly", "value": "", "type": "query", "description": "This creates an onboarding with a new CPS certificate and security protections. If your contract limits how many certificates you create, the API responds with an error." }, { "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": "__App & API Protector__, __App & API Protector with the Advanced Security module__ Create a new onboarding. To start, you'll need a valid set of hostnames that either need delivery settings, an Akamai-owned certificate from the Certificate Provisioning System (CPS), and security protections, or have delivery settings complete and only need security protections. However, you can include only one type of these hostnames per onboarding, not both. If you have both kinds of hostnames, those that need" }, { "info": { "name": "Get an onboarding", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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": "__App & API Protector__, __App & API Protector with the Advanced Security module__ Get an onboarding's details. Once you've completed all steps in the onboarding process, run this call again to verify `onboardingStatus: \"COMPLETE\"`." }, { "info": { "name": "Delete an onboarding", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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": "__App & API Protector__, __App & API Protector with the Advanced Security module__ Delete a specific onboarding. You can't delete an onboarding that has an activation in progress. To delete an onboarding that's activating, wait for the activation to complete, then run this operation." }, { "info": { "name": "Get onboarding settings", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/settings", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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": "__App & API Protector__, __App & API Protector with the Advanced Security module__ Gets the settings for a specific onboarding." }, { "info": { "name": "Modify onboarding settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/settings", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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": "__App & API Protector__, __App & API Protector with the Advanced Security module__ Update the settings in an onboarding. You can't update settings for an onboarding object that has already activated on staging or production. You can, however, change settings for an onboarding that has not been activated." } ] }, { "info": { "name": "Onboarding: Activations and status", "type": "folder" }, "items": [ { "info": { "name": "Activate an onboarding", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/activations", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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": "__App & API Protector__, __App & API Protector with the Advanced Security module__ Activate an onboarding on the staging or production networks. You need to activate on the staging network before you can activate on production. Note that with this operation you can only activate on one network at a time. Once you activate on staging you can test your site as you normally would when using Property Manager or any of our security products." }, { "info": { "name": "Get an onboarding activation", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/activations/:activationId", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "name": "activationId", "value": "", "type": "path", "description": "A unique identifier for an activation." }, { "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": "__App & API Protector__, __App & API Protector with the Advanced Security module__ Returns the status of an activation. Activations can take about 20 minutes. If the activation fails, to specific information about the failure is returned in the error response." } ] }, { "info": { "name": "Onboarding: Post-activation validation", "type": "folder" }, "items": [ { "info": { "name": "List onboarding certificate challenges", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/certificate-validation", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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 information you need to validate your certificate. Add the `TXT` DNS record listed in the response to your DNS record. Adding the `TXT` record won't affect your website. Once you've added the `TXT` record, and before the token expires, run [Validate onboarding certificate](https://techdocs.akamai.com/application-security/docs/post-onboarding-certificate-validation) to validate the certificate." }, { "info": { "name": "Validate onboarding certificate", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/certificate-validation/validate", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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__ Validates the certificate's `TXT` DNS record. Once validation completes, it takes about five minutes to deploy the certificates across Akamai's global network. You can validate with HTTP token, DNS records, or URL redirect." }, { "info": { "name": "List hostname CNAME DNS records", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/cname-to-akamai", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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 DNS records you need to CNAME to Akamai. Once you update your CNAME record with the information in this call's response, your end user traffic starts to flow through Akamai's platform. Note that you can only CNAME to Akamai after an activation on staging or production is complete." }, { "info": { "name": "Validate hostname CNAME DNS records", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/cname-to-akamai/validate", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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__ Validates your site is ready to serve traffic. Call this operation after you've replaced the DNS entry that directs traffic to your site with the DNS CNAME records in [List hostname CNAME DNS records](https://techdocs.akamai.com/application-security/docs/get-onboarding-cname-records). In each record, set the time-to-live (TTL) to 300 seconds (5 minutes). Once this call completes, run [Get an onboarding](https://techdocs.akamai.com/application-security/docs/get-onboarding) to ver" }, { "info": { "name": "List onboarding domain challenges", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/domain-validation", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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 information you need to validate your domains. Add the `TXT` or `CNAME` value listed in the response to your DNS record. Adding the record won't affect your website. Once you've added the record, and before the token expires, run [Validate onboarding domains](https://techdocs.akamai.com/application-security/docs/post-onboarding-domain-validation)." }, { "info": { "name": "Validate onboarding domains", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/domain-validation/validate", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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__ Verifies the domain validation challenges. You can validate with HTTP token, DNS records, or URL redirect." }, { "info": { "name": "List origin hostname DNS records", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/origin-validation", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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 the DNS records for your origin. Once you make this call, visit your DNS provider account and create a new DNS type `A` record with the values returned in the response. In the rare case that you changed your origin values outside this setup, you can run [Skip origin validation](https://techdocs.akamai.com/application-security/docs/post-skip-onboarding-origin-validation) to proceed to the next step without validating your origin at this time." }, { "info": { "name": "Skip origin hostnames DNS record validation", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/origin-validation/skip", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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__ Skips the validation of `A` DNS record. In the rare case that you changed your origin values outside this onboarding, you can choose not to complete the origin validation process through this onboarding workflow. Skipping for any other reason may cause your site to become unreachable. When you choose to skip validating your origin through this call, the response shows the records with a value of `skipped`." }, { "info": { "name": "Validate origin hostnames DNS records", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/onboardings/:onboardingId/origin-validation/validate", "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A unique identifier for an onboarding." }, { "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__ Validates the `A` DNS record you entered into your DNS record. In the rare case that you changed your origin values outside this setup, you can run [Skip origin validation](https://techdocs.akamai.com/application-security/docs/post-skip-onboarding-origin-validation) to proceed to the next step without validating your origin at this time." } ] } ], "bundled": true }