{ "opencollection": "1.0.0", "info": { "name": "Akamai: Application Security Activation history General configuration settings API", "version": "v1" }, "items": [ { "info": { "name": "General configuration settings", "type": "folder" }, "items": [ { "info": { "name": "Akamai API Security List Configurations", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs", "params": [ { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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": "Lists available security configurations. _Products:_ All." }, { "info": { "name": "Akamai API Security Create a Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs", "params": [ { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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 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. _Products:_ All." }, { "info": { "name": "Akamai API Security Get a Security Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "includeHostnames", "value": "{{includeHostnames}}", "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": "{{accountSwitchKey}}", "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": "Retrieves the configuration details." }, { "info": { "name": "Akamai API Security Rename a Security Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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": "Update the name of your security configuration. _Products:_ All." }, { "info": { "name": "Akamai API Security Delete a Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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 security configuration. _Products:_ All." }, { "info": { "name": "Akamai API Security List Configuration Versions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "page", "value": "{{page}}", "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": "{{pageSize}}", "type": "query", "description": "The number of items on each result page. The default value is `25`." }, { "name": "detail", "value": "{{detail}}", "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": "{{accountSwitchKey}}", "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": "Lists available versions for the specified security configuration, with results optionally paginated. _Products:_ All." }, { "info": { "name": "Akamai API Security Clone a Configuration Version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/appsec/v1/configs/:configId/versions", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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 version of the specified security configuration. _Products:_ All." }, { "info": { "name": "Akamai API Security Get Configuration Version Details", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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 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. _Products:_ All." }, { "info": { "name": "Akamai API Security Delete a Configuration Version", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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": "Delete the specified configuration version. You can't delete a version that's actively in use. _Products:_ All." }, { "info": { "name": "Akamai API Security Get the Version Notes", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/version-notes", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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 the most recent version notes for a configuration. _Products:_ All." }, { "info": { "name": "Akamai API Security Modify Version Notes", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/version-notes", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "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": "Update the most recent version notes for a configuration. _Products:_ All." } ] } ], "bundled": true }