Akamai: EdgeKV API
Akamai: EdgeKV API endpoints from Akamai
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Akamai: EdgeKV API endpoints from Akamai
Endpoints 19
Namespaces
- PUTModify the default Data Access Policy
/auth/database?accountSwitchKey={{accountSwitchKey}}Modify the default Data Access Policy setting that's applied for newly created namespaces. You need an additional Standard TLS Support contract entitlement to… - PUTReauthorize a namespace
/auth/namespaces/:namespaceId?accountSwitchKey={{accountSwitchKey}}Assign an existing namespace to a different Akamai access group. - GETList namespaces
/networks/:network/namespaces?details={{details}}&accountSwitchKey={{accountSwitchKey}}View a list of all EdgeKV namespaces. - POSTCreate a namespace
/networks/:network/namespaces?accountSwitchKey={{accountSwitchKey}}Creates a namespace on Akamai's STAGING or PRODUCTION network. You should create namespaces in both networks so that you can test your EdgeWorkers code on… - GETGet namespace details
/networks/:network/namespaces/:namespaceId?accountSwitchKey={{accountSwitchKey}}View details for the specified namespace. - PUTUpdate namespace details
/networks/:network/namespaces/:namespaceId?accountSwitchKey={{accountSwitchKey}}You can update the retention period for any existing namespace other than the default namespace. It can take up to five minutes for a new retention policy to… - GETList groups within a namespace
/networks/:network/namespaces/:namespaceId/groups?accountSwitchKey={{accountSwitchKey}}List group identifiers created when writing items to a namespace. You need to specify at least one of these group identifiers in the groupId parameter when…
Permission groups
- GETList permission groups
/auth/groups?accountSwitchKey={{accountSwitchKey}}View a list of access groups and your associated permission capabilities, such as create a namespace or read data from a namespace. - GETGet a permission group
/auth/groups/:groupId?accountSwitchKey={{accountSwitchKey}}View details permissions available within the specified access group, such as create a namespace or read data from a namespace.
EdgeKV status
- GETGet the EdgeKV initialization status
/initialize?accountSwitchKey={{accountSwitchKey}}View the EdgeKV initialization status. - PUTInitialize EdgeKV
/initialize?accountSwitchKey={{accountSwitchKey}}You only need to initialize EdgeKV once. This operation adds the default EdgeKV namespace to Akamai's STAGING and PRODUCTION networks. It also creates a new…
Items
- GETList items within a group
/networks/:network/namespaces/:namespaceId/groups/:groupId?maxItems={{maxItems}}&sandboxId={{sandboxId}}&accountSwitchKey={{accountSwitchKey}}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… - GETRead an item
/networks/:network/namespaces/:namespaceId/groups/:groupId/items/:itemId?sandboxId={{sandboxId}}&accountSwitchKey={{accountSwitchKey}}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… - PUTWrite an item
/networks/:network/namespaces/:namespaceId/groups/:groupId/items/:itemId?sandboxId={{sandboxId}}&accountSwitchKey={{accountSwitchKey}}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… - DELETEDelete an item
/networks/:network/namespaces/:namespaceId/groups/:groupId/items/:itemId?sandboxId={{sandboxId}}&accountSwitchKey={{accountSwitchKey}}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…
Access tokens
- GETList access tokens
/tokens?includeExpired={{includeExpired}}&accountSwitchKey={{accountSwitchKey}}View a list of EdgeKV access tokens. - POSTCreate an access token
/tokens?accountSwitchKey={{accountSwitchKey}}Generate an access token that allows an EdgeWorkers code bundle to access the specified namespace. Each token name needs to be unique and have a defined… - GETDownload an access token
/tokens/:tokenName?accountSwitchKey={{accountSwitchKey}}Download a previously created EdgeKV access token. To get a token you need to know the token name. To learn more about access tokens, refer to the EdgeKV guide. - DELETERevoke an access token
/tokens/:tokenName?accountSwitchKey={{accountSwitchKey}}Once you revoke an access token, you can't undo it. You also need to update any deployed EdgeWorkers code bundles that use the old token with a new token, or…
API details
- Base URL
https://{hostname}/edgekv/v1- Authentication
- None declared in the description
- Operations
- 19 operations on 12 pathsGET 10PUT 5POST 2DELETE 2
- Main resources
- Namespaces 7Access tokens 4Items 4EdgeKV status 2Permission groups 2
- Response formats
application/problem+jsonapplication/jsontext/plain- Description format
- OpenAPI 3.0.0, API version
1 - Links
- Documentation · OpenAPI document
- Listed from
- Akamai's published OpenAPI description (akamai/akamai-apis) (Apache-2.0)
How to test the Akamai: EdgeKV API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: EdgeKV API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Modify the default Data Access Policy” (PUT /auth/database?accountSwitchKey={{accountSwitchKey}}), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Akamai: EdgeKV API?
Akamai: EdgeKV API endpoints from Akamai It is listed under Developer tools and has 19 endpoints.
Who publishes the Akamai: EdgeKV API?
It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Akamai: EdgeKV API?
Requests go to https://{hostname}/edgekv/v1. Endpoint paths are added to this base URL.
How do I authenticate with the Akamai: EdgeKV API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Akamai: EdgeKV API have?
19 operations on 12 paths (10 GET, 5 PUT, 2 POST, 2 DELETE). The largest groups are Namespaces, Access tokens, Items, EdgeKV status.
Is forking the Akamai: EdgeKV API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.