{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Configuration version export API", "version": "2" }, "items": [ { "info": { "name": "Configuration version export", "type": "folder" }, "items": [ { "info": { "name": "Asynchronously export a configuration version", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/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}/api-definitions/v2/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}/api-definitions/v2/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}/api-definitions/v2/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." } ] } ], "bundled": true }