Akamai

Akamai: NetStorage Configuration API

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

Endpoints 26

CP codes

  • POSTCreate a CP code/cpcodes?accountSwitchKey={{accountSwitchKey}}This operation creates a CP code for use with NetStorage.
  • GETList unused CP Codes/cpcodes/unused?contractId={{contractId}}&accountSwitchKey={{accountSwitchKey}}Get a list of CP codes that aren't assigned to a storage group.
  • GETList CP codes in use/cpcodes/used?accountSwitchKey={{accountSwitchKey}}Get a list of all CP codes that are assigned to a storage group.
  • GETView the automatic purge routine/cpcodes/:cpcodeId/age-deletions?ageDeletionDirectoryPrefix={{ageDeletionDirectoryPrefix}}&accountSwitchKey={{accountSwitchKey}}View the automatic purge routines for a cpcodeId. You can optionally include a URL-encoded ageDeletionDirectoryPrefix to filter an individual purge routine.
  • PUTModify a purge routine/cpcodes/:cpcodeId/age-deletions?ageDeletionDirectoryPrefix={{ageDeletionDirectoryPrefix}}&accountSwitchKey={{accountSwitchKey}}Make changes to an automatic purge routine for a specific CP code.
  • DELETEDelete an automatic purge routine/cpcodes/:cpcodeId/age-deletions?ageDeletionDirectoryPrefix={{ageDeletionDirectoryPrefix}}&accountSwitchKey={{accountSwitchKey}}Delete the automatic purge routine for a specific CP code.

Rule sets

  • GETList all rule sets/rule-sets?accountSwitchKey={{accountSwitchKey}}Get a list of rule sets.
  • POSTCreate a rule set/rule-sets?accountSwitchKey={{accountSwitchKey}}Create a rule set.
  • GETGet a rule set/rule-sets/:ruleSetId?accountSwitchKey={{accountSwitchKey}}Get details for a specific rule set.
  • PUTUpdate a rule set/rule-sets/:ruleSetId?accountSwitchKey={{accountSwitchKey}}Update a specific rule set.
  • DELETEDelete a rule set/rule-sets/:ruleSetId?accountSwitchKey={{accountSwitchKey}}Delete a specified rule set.

Snapshots

  • GETList all site snapshots/site-snapshots?accountSwitchKey={{accountSwitchKey}}Get a list of all site snapshots.
  • POSTCreate a site snapshot/site-snapshots?accountSwitchKey={{accountSwitchKey}}Use this operation to create a new site snapshot configuration.
  • POSTCreate an immediate site snapshot/site-snapshots/schedule-now?snapshotId={{snapshotId}}&snapshotName={{snapshotName}}&accountSwitchKey={{accountSwitchKey}}Create an immediate snapshot for a snapshotId and snapshotName you provide.
  • GETGet a site snapshot schedule/site-snapshots/:snapshotId?accountSwitchKey={{accountSwitchKey}}Get the site snapshot schedule for a snapshotId.
  • PUTUpdate a site snapshot schedule/site-snapshots/:snapshotId?accountSwitchKey={{accountSwitchKey}}Update a site snapshot schedule for a snapshotId.
  • DELETEDelete a site snapshot/site-snapshots/:snapshotId?accountSwitchKey={{accountSwitchKey}}Use this operation to delete a specific site snapshot configuration using its snapshotId.

Groups

  • GETList storage groups/storage-groups?cpcodeId={{cpcodeId}}&storageGroupPurpose={{storageGroupPurpose}}&accountSwitchKey={{accountSwitchKey}}Get a list of all of the storage groups in your NetStorage instance, optionally filtered by CP code or the storage group's categorized purpose.
  • POSTCreate a storage group/storage-groups?accountSwitchKey={{accountSwitchKey}}This operation creates a new storage group to house your content.
  • GETGet a storage group/storage-groups/:storageGroupId?accountSwitchKey={{accountSwitchKey}}Get a specific storage group based on its storageGroupId.
  • PUTEdit a storage group/storage-groups/:storageGroupId?accountSwitchKey={{accountSwitchKey}}Update storage group based on its unique ID value.

Accounts

  • GETList upload accounts/upload-accounts?accountSwitchKey={{accountSwitchKey}}Get a list of upload accounts for all storage groups in your NetStorage instance.
  • POSTCreate a new upload account/upload-accounts?accountSwitchKey={{accountSwitchKey}}Create an upload account for a storage group.
  • GETGet an upload account/upload-accounts/:uploadAccountId?accountSwitchKey={{accountSwitchKey}}Get a specific upload account based on its unique ID value.
  • PUTEdit an upload account/upload-accounts/:uploadAccountId?accountSwitchKey={{accountSwitchKey}}Update an upload account based on its uploadAccountId.

Zones

  • GETList zones/zones?accountSwitchKey={{accountSwitchKey}}Get a list of the geographic regions (*zones*) you can use to replicate your content.

API details

Base URL
https://{hostname}/storage/v1
Authentication
None declared in the description
Operations
26 operations on 14 pathsGET 12POST 6PUT 5DELETE 3
Main resources
CP codes 6Snapshots 6Rule sets 5Accounts 4Groups 4Zones 1
Response formats
application/problem+json application/json */*
Description format
OpenAPI 3.0.0, API version 1

How to test the Akamai: NetStorage Configuration 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: NetStorage Configuration 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 “Create a CP code” (POST /cpcodes?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: NetStorage Configuration API?

Akamai: NetStorage Configuration API endpoints from Akamai It is listed under Developer tools and has 26 endpoints.

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

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

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

26 operations on 14 paths (12 GET, 6 POST, 5 PUT, 3 DELETE). The largest groups are CP codes, Snapshots, Rule sets, Accounts.

Is forking the Akamai: NetStorage Configuration 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.