{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Categories API", "version": "2" }, "items": [ { "info": { "name": "Categories", "type": "folder" }, "items": [ { "info": { "name": "List categories", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/categories", "params": [ { "name": "withUsageInfo", "value": "{{withUsageInfo}}", "type": "query", "description": "Whether the response should include the `usageCount` data indicating the number of endpoints under a category, `false` by default." }, { "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 all categories available to tag endpoints and optionally indicates the number of endpoints tagged under each category." }, { "info": { "name": "Create a category", "type": "http" }, "http": { "method": "POST", "url": "https://{hostname}/api-definitions/v2/categories", "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": "Creates a category that you can use to tag endpoints. The request's `apiCategoryName` needs to be unique per account." }, { "info": { "name": "Get a category", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/categories/:apiCategoryId", "params": [ { "name": "apiCategoryId", "value": "{{apiCategoryId}}", "type": "path", "description": "The unique identifier for the category." }, { "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 specific category that you can use to tag endpoints." }, { "info": { "name": "Edit a category", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/categories/:apiCategoryId", "params": [ { "name": "apiCategoryId", "value": "{{apiCategoryId}}", "type": "path", "description": "The unique identifier for the category." }, { "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": "Updates a category's description or unique name." }, { "info": { "name": "Delete a category", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/categories/:apiCategoryId", "params": [ { "name": "apiCategoryId", "value": "{{apiCategoryId}}", "type": "path", "description": "The unique identifier for the category." }, { "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": "Removes an unassigned category. If you assigned the category to at least one endpoint, the operation returns a 403 error." } ] } ], "bundled": true }