Sandbox CLI expedites the process of creating an isolated development environment for testing site changes or Akamai property configurations.

Technical setup requirements

In order to use this tool, you need to have:

Akamai CLI installed. If you have a Mac with brew installed, enter brew install akamai.
An API client for both Property Manager API (PAPI) and Sandbox API with read-write access. Follow the steps in Create authentication credentials to learn how to configure authentication tokens to access the API.
Node version 8+.
Java version 8+.
Set the Java HOME variable.

Workflow

Follow these steps to get up and running quickly with Sandbox.

Steps	Description
Create a sandbox with the CLI	Quickly create a sandbox at the command line.
Update a sandbox with the CLI	Make changes to your sandbox.
Configure Sandbox Client with the CLI	Update origin mappings for your Sandbox Client.
Integrate your sandbox with devops automation tool	Create a template you can integrate with your devops automation tool.
Test EdgeWorkers functions in your sandbox	Use the Sandbox CLI to test your EdgeWorkers functions before deploying.

📘
For a complete list of endpoints, refer to Sandbox API.