{ "opencollection": "1.0.0", "info": { "name": "Akamai: API Endpoint Definition Access tokens Items API", "version": "2" }, "items": [ { "info": { "name": "Items", "type": "folder" }, "items": [ { "info": { "name": "Akamai List Items Within a Group", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/networks/:network/namespaces/:namespaceId/groups/:groupId", "params": [ { "name": "groupId", "value": "{{groupId}}", "type": "path", "description": "Unique identifier for each group within a namespace." }, { "name": "namespaceId", "value": "{{namespaceId}}", "type": "path", "description": "Unique identifier for each namespace." }, { "name": "network", "value": "{{network}}", "type": "path", "description": "__Enum__ Network environment to execute the API request on." }, { "name": "maxItems", "value": "{{maxItems}}", "type": "query", "description": "If specified, maximum number of items to return per request, up to the system [limits](https://techdocs.akamai.com/edgekv/docs/limits)." }, { "name": "sandboxId", "value": "{{sandboxId}}", "type": "query", "description": "Accesses EdgeKV data in the specified sandbox environment. To list existing sandbox identifiers, run the Sandbox API's [List sandboxes](https://techdocs.akamai.com/sandbox/reference/get-sandboxes) operation." }, { "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": "View the details of an EdgeKV item (key-value pair) within a group. You need to specify the `namespace` and `group` the item belongs to. This operation returns up to 100 items by default or the number of items specified in the `maxItems`. If there are more than the default or requested items in the specified group, the operation returns a random set of the default or requested items. It can take ten seconds or longer to read an item that has been written to EdgeKV. The API may respond with a 404" }, { "info": { "name": "Akamai Read an Item", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/api-definitions/v2/networks/:network/namespaces/:namespaceId/groups/:groupId/items/:itemId", "params": [ { "name": "itemId", "value": "{{itemId}}", "type": "path", "description": "Unique identifier for each item. The key of a key-value pair." }, { "name": "groupId", "value": "{{groupId}}", "type": "path", "description": "Unique identifier for each group within a namespace." }, { "name": "namespaceId", "value": "{{namespaceId}}", "type": "path", "description": "Unique identifier for each namespace." }, { "name": "network", "value": "{{network}}", "type": "path", "description": "__Enum__ Network environment to execute the API request on." }, { "name": "sandboxId", "value": "{{sandboxId}}", "type": "query", "description": "Accesses EdgeKV data in the specified sandbox environment. To list existing sandbox identifiers, run the Sandbox API's [List sandboxes](https://techdocs.akamai.com/sandbox/reference/get-sandboxes) operation." }, { "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": "Read an EdgeKV item. You need to specify the `namespace` and `group` the item belongs to. It can take ten seconds or longer to read an item that has been recently written to EdgeKV. The API may return a 404 error during that period. This is normal behavior for EdgeKV, which is an eventually consistent database." }, { "info": { "name": "Akamai Write an Item", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/api-definitions/v2/networks/:network/namespaces/:namespaceId/groups/:groupId/items/:itemId", "params": [ { "name": "itemId", "value": "{{itemId}}", "type": "path", "description": "Unique identifier for each item. The key of a key-value pair." }, { "name": "groupId", "value": "{{groupId}}", "type": "path", "description": "Unique identifier for each group within a namespace." }, { "name": "namespaceId", "value": "{{namespaceId}}", "type": "path", "description": "Unique identifier for each namespace." }, { "name": "network", "value": "{{network}}", "type": "path", "description": "__Enum__ Network environment to execute the API request on." }, { "name": "sandboxId", "value": "{{sandboxId}}", "type": "query", "description": "Accesses EdgeKV data in the specified sandbox environment. To list existing sandbox identifiers, run the Sandbox API's [List sandboxes](https://techdocs.akamai.com/sandbox/reference/get-sandboxes) operation." }, { "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 or update an EdgeKV item (name-value). You need to specify the `namespace` and `group` the item belongs to. The target `namespace` must already exist before writing, while the `group` is automatically created for you if it doesn't exist yet." }, { "info": { "name": "Akamai Delete an Item", "type": "http" }, "http": { "method": "DELETE", "url": "https://{hostname}/api-definitions/v2/networks/:network/namespaces/:namespaceId/groups/:groupId/items/:itemId", "params": [ { "name": "itemId", "value": "{{itemId}}", "type": "path", "description": "Unique identifier for each item. The key of a key-value pair." }, { "name": "groupId", "value": "{{groupId}}", "type": "path", "description": "Unique identifier for each group within a namespace." }, { "name": "namespaceId", "value": "{{namespaceId}}", "type": "path", "description": "Unique identifier for each namespace." }, { "name": "network", "value": "{{network}}", "type": "path", "description": "__Enum__ Network environment to execute the API request on." }, { "name": "sandboxId", "value": "{{sandboxId}}", "type": "query", "description": "Accesses EdgeKV data in the specified sandbox environment. To list existing sandbox identifiers, run the Sandbox API's [List sandboxes](https://techdocs.akamai.com/sandbox/reference/get-sandboxes) operation." }, { "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": "Mark an EdgeKV item for deletion. You need to specify the `namespace` and `group` the item belongs to. It can take ten seconds or longer for a deleted item to be removed from the database. If you attempt a read operation before the value has been updated globally, stale data may be returned until the update is complete. This is normal behavior for EdgeKV, which is an eventually consistent database." } ] } ], "bundled": true }