Configure API privacy

By making your API configuration private, you prevent unauthenticated parties from interacting with your endpoint and its associated resources. This improves the security of your system by leveraging the API key authentication method. You can define API privacy at the endpoint level and for every individual resource within your configuration.

Try the API: You can also complete this task by using the API Endpoints API. Run the Update API privacy settings operation. Learn more about Akamai’s APIs.

Before you begin

Ensure that you specified an API key location for the API that you want to make private. For details, see step 5 in Register an API.

How to

  1. On the API Definitions page, in the Registered APIs section, click the ellipsis icon () associated with the API configuration you want to configure API privacy settings for.
  2. From the menu, select Manage versions.
  3. In the Version history panel, click the ellipsis icon () associated with the API configuration version you want to configure API privacy settings for.
  4. From the list of delivery options, select API privacy settings.
  5. On the API privacy settings page, set the Make this API switch to Private.
  6. Optional: If you want to make some resources in your API public, in the Resource privacy settings panel, set their corresponding Make this resource switches to Public.
    If you decide to reset API privacy settings for all resources to the API level at any point, you can click Reset to API settings. You can also control which individual resources inherit the top-level settings by selecting their Inherit check boxes.
  7. Click Save.