Akamai

Akamai: Sandbox API

Akamai: Sandbox API endpoints from Akamai

Developer tools#openapi

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: Sandbox API endpoints from Akamai

Endpoints 17

Sandboxes

  • GETList sandboxes/sandboxes?access={{access}}&accountSwitchKey={{accountSwitchKey}}This operation returns a list of sandboxes. In the response object, you can see the sandboxId, the developer who created the sandbox, and the sandbox name.…
  • POSTCreate a sandbox/sandboxes?accountSwitchKey={{accountSwitchKey}}You can create a sandbox based on an existing property, hostname, or property version. Refer to the example JSONs for each use case in the Recipes. In order…
  • GETGet a sandbox/sandboxes/:sandboxId?access={{access}}&accountSwitchKey={{accountSwitchKey}}Get a specific sandbox based on sandboxId.
  • PUTModify a sandbox/sandboxes/:sandboxId?accountSwitchKey={{accountSwitchKey}}Enable isClonable if you have preconfigured the settings for the sandbox and want to make it possible for other developers to create an exact replica in their…
  • DELETEDelete a sandbox/sandboxes/:sandboxId?access={{access}}&accountSwitchKey={{accountSwitchKey}}Remove a specific sandbox instance based on sandboxId. This is useful when you have completed testing and no longer need the sandbox, or when you are…
  • POSTClone a sandbox/sandboxes/:sandboxId/clone?accountSwitchKey={{accountSwitchKey}}Create a new sandbox instance based on the specified sandboxId. You can clone a sandbox that has isClonable enabled. This is useful if you want to copy a…

EdgeWorkers

  • GETDownload EdgeWorker code/sandboxes/:sandboxId/edgeworkers/:edgeWorkerId?access={{access}}&accountSwitchKey={{accountSwitchKey}}Retrieve the script bundle in .tgz form for the specified sandboxId and edgeWorkerId. To learn more about EdgeWorkers, refer to the EdgeWorkers API.
  • PUTUpload EdgeWorker code/sandboxes/:sandboxId/edgeworkers/:edgeWorkerId?access={{access}}&accountSwitchKey={{accountSwitchKey}}Add a script bundle for a given edgeWorkerId to the specified sandboxId.
  • DELETEDelete EdgeWorker/sandboxes/:sandboxId/edgeworkers/:edgeWorkerId?access={{access}}&accountSwitchKey={{accountSwitchKey}}Delete an EdgeWorker with an edgeWorkerId from the specified sandboxId.

Properties

  • GETList properties/sandboxes/:sandboxId/properties?access={{access}}&accountSwitchKey={{accountSwitchKey}}This operation returns a list of sandbox properties available to the current user.
  • POSTAdd a property to a sandbox/sandboxes/:sandboxId/properties?accountSwitchKey={{accountSwitchKey}}You can add a property to a sandbox. Use this if you need to support more than one hostname in your sandbox environment.
  • GETRead a property/sandboxes/:sandboxId/properties/:sandboxPropertyId?access={{access}}&accountSwitchKey={{accountSwitchKey}}Get a specific property of a sandbox so you can review the information in the response body.
  • PUTUpdate a property/sandboxes/:sandboxId/properties/:sandboxPropertyId?access={{access}}&accountSwitchKey={{accountSwitchKey}}Update the requestHostnames of the sandbox property. Your sandbox can support multiple hostnames for testing purposes.
  • DELETEDelete a property/sandboxes/:sandboxId/properties/:sandboxPropertyId?access={{access}}&accountSwitchKey={{accountSwitchKey}}Remove a property from a sandbox. This operation applies when the sandbox contains more than one property. You cannot delete the only property of a sandbox.
  • GETGet a rule tree/sandboxes/:sandboxId/properties/:sandboxPropertyId/rules?access={{access}}&accountSwitchKey={{accountSwitchKey}}Get a specific rule tree of a sandbox property. Each sandbox property references one rule tree. For more information on how content-handling rules are…
  • PUTUpdate a rule tree/sandboxes/:sandboxId/properties/:sandboxPropertyId/rules?access={{access}}&accountSwitchKey={{accountSwitchKey}}Modify the rules of a sandbox property to make changes to content-handling behaviors for testing purposes within your development environment. Once you are…

Rotate JWT

  • POSTRotate the JWT/sandboxes/:sandboxId/rotateJWT?access={{access}}&accountSwitchKey={{accountSwitchKey}}Generate a new jwtToken (JSON Web Token) for the specified sandbox instance. Use this to prevent access to a particular sandbox by developers who had the…

API details

Base URL
https://{hostname}/sandbox-api/v1
Authentication
None declared in the description
Operations
17 operations on 8 pathsGET 6PUT 4POST 4DELETE 3
Main resources
Properties 7Sandboxes 6EdgeWorkers 3Rotate JWT 1
Response formats
application/json */*
Description format
OpenAPI 3.0.0, API version v0

How to test the Akamai: Sandbox API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Sandbox API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List sandboxes” (GET /sandboxes?access={{access}}&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: Sandbox API?

Akamai: Sandbox API endpoints from Akamai It is listed under Developer tools and has 17 endpoints.

Who publishes the Akamai: Sandbox 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: Sandbox API?

Requests go to https://{hostname}/sandbox-api/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Akamai: Sandbox 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: Sandbox API have?

17 operations on 8 paths (6 GET, 4 PUT, 4 POST, 3 DELETE). The largest groups are Properties, Sandboxes, EdgeWorkers, Rotate JWT.

Is forking the Akamai: Sandbox API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.