{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Shared resources: Rate policies API", "version": "2" }, "items": [ { "info": { "name": "Shared resources: Rate policies", "type": "folder" }, "items": [ { "info": { "name": "List rate policies", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/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}/api-definitions/v2/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}/api-definitions/v2/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}/api-definitions/v2/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}/api-definitions/v2/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}/api-definitions/v2/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." } ] } ], "bundled": true }