The edgekv Developer Hub

Welcome to the edgekv developer hub. You'll find comprehensive guides and documentation to help you start working with edgekv as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Initialize the EdgeKV database

The first step is to initialize your EdgeKV database which creates a default namespace with a six-month retention period for your account. It also creates a new dedicated CP Code to track your EdgeKV usage.

👍

The retention period of the database can be changed at your discretion. For more information see, Update an EdgeKV namespace.

You should only use the default namespace for experimentation and testing purposes. When deploying your EdgeKV database in production, please use a new namespace with a different name.

The role associated with the API client used to initialize the EdgeKV database must include the following permissions:

  • CP Code - View CP Code Information
  • Edit Access to Property Manager

The above permissions are assigned by default to the “Admin” role. If you do not have this role, or another role with the above permissions, you will not be able to initialize the database.

You also need to use the top level group for your ​Control Center​ account for the API client or CLI credentials. These requirements only apply the initialization step.

For more information, refer to the Identity and Access Management documentation.

👍

You should get a 201 response status code if your initialization operation is successful. If you do not, please refer to Why is the initialization command failing? in the FAQ section for more information.

Use the API to initialize the EdgeKV database

  1. Initialize your EdgeKV database using the PUT verb on the initialize endpoint:
PUT /edgekv/v1/initialize
  1. Here is a sample request:
$ http --auth-type edgegrid -a default: PUT :/edgekv/v1/initialize
  1. To check the current initialization status you can use the GET verb on the initialize endpoint:
GET /edgekv/v1/initialize
  1. Here is an example of the response:
HTTP/1.1 200 OK
Content-Type: application/json
 {
    "accountStatus": "INITIALIZED",
    "cpcode": "123456",
    "productionStatus": "INITIALIZED",
    "stagingStatus": "INITIALIZED"
}

📘

You will not be able to invoke other APIs or use your EdgeKV database until the initialization has completed successfully.

Use the CLI to initialize the EdgeKV database

When you initialize your EdgeKV database, it creates a default namespace for your account. It also creates a new dedicated CP Code to track your EdgeKV usage.

Before you begin, review the steps in EdgeKV Command-Line Interface (CLI) for more information.

📘

To make calls on the Akamai network using the EdgeKV CLI you need to create an API client and configure proper credentials. See the Get started documentation for more information.

  1. Initialize your EdgeKV database.
% akamai edgekv initialize
  1. To check the current initialization status use this command.
% akamai edgekv show status
--- EdgeKV already INITIALIZED ---
----------------------------------
AccountStatus  ProductionStatus  StagingStatus  Cpcode
-------------  ----------------  -------------  -------
INITIALIZED    INITIALIZED       INITIALIZED    123456

Updated 3 months ago


Initialize the EdgeKV database


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.