{ "opencollection": "1.0.0", "info": { "name": "Akamai: Application Security Activation history General policy settings API", "version": "v1" }, "items": [ { "info": { "name": "General policy settings", "type": "folder" }, "items": [ { "info": { "name": "Akamai API Security List Security Policies", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies", "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": "notMatched", "value": "{{notMatched}}", "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": "{{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": "Returns a list of security policies available for the specified security configuration. _Products:_ All." }, { "info": { "name": "Akamai API Security 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": "{{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": "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. _Products:_ Kona Site Defender, App & API Protector with the Advanced Security module." }, { "info": { "name": "Akamai API Security 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": "{{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": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "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 the specified security policy. _Products:_ All." }, { "info": { "name": "Akamai API Security 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": "{{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": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "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 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). _Products:_ All." }, { "info": { "name": "Akamai API Security 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": "{{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": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "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 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 configuration version](https://techdocs.akamai.com/application-security/reference/post-co" } ] } ], "bundled": true }