Get started

To configure this API for the first time:

  • Make sure NetStorage is in your contract. You can find the list of products within your account in ​Control Center​ under Contracts. Contact your ​Akamai​ support team to enable if necessary.

  • You need different permissions to access API functions. You can manage permissions in ​Control Center​. Learn more about the access control model.

  • Before you can use this API, you need to Create authentication credentials.

    • The code examples shown in this API documentation are for reference but do not contain the required authentication code syntax you need to make API calls. For code samples you can copy and paste, check out the Recipes. To learn how to apply authentication in a variety of programming languages when using Akamai APIs, refer to Authenticate with EdgeGrid.

    • Verify you have the API service named NetStorage in the Identity and Access Management tool, and its access level is set to READ-WRITE. This gives you access to all of the operations in this API.

  • Get your contractId. Several operations in this API require this value. You can find your contractId using the Contract API:

    • List contracts. If you only have one, you’re done. Store this as your contractId. If you have more than one, note these values and continue.

    • List products per contract. Set the {contractId} variable to one you’ve noted.

    • Look for a marketingProductId of NetStorage in the response. If you find it, this contract has NetStorage enabled, and you can use this contractId.

  • Generate CP codes for your storage groups. You can use these approaches to generate CP codes:

    • Use this API to create a CP code
    • Use the NetStorage application in ​Control Center​ to create CP codes when adding a new upload directory ( > ORIGIN SERVICES > NetStorage).
    • Contact your account representative for help generating the number of CP codes you need.

The NetStorage network has a propagation time requirement. Any action that adds (POST), updates (PUT) or removes (DELETE) an object takes upwards of 60 minutes to propagate. For example, creating a new upload account (POST) using the API requires propagation, which can take 60 minutes before the account is accessible for use.


Provide feedback or ask a question in the Akamai Developer Discussion Forum. You can also contact your Akamai account team for support. We want to hear from you!