Import API details

You can populate most of the API endpoint and resource information automatically by importing an API definition file in an OpenAPI (Swagger) or RAML format. If desired, you can edit the imported values before saving your API configuration. You can use the import feature either when registering an entirely new API, or when editing details about an existing inactive API.

For the specific import file contents supported at Akamai, see Supported API definition elements.

For general information on how to create your API definition file, see one of the following specifications:

Try the API: You can also complete this task by using the API Endpoints API. Run the Create an endpoint from an API definition file operation. Learn more about Akamai’s APIs.

How to

  1. On the Register new API page, click Import API definition.
    If you’re importing an API definition file to an already existing API configuration, this button says Reimport API definition.
  2. In the Import API window, select the Import file format of your API definition file.
    If you’re importing an API definition file to an already existing API configuration, the window’s name is Reimport API.
  3. In the Import API from area, do one of the following:
    • To fetch and import a file stored on the web, select URL and enter the address in the URL field.
    • To import a local file, select File, click Choose file, and go to the file that you want to upload.
      Note: You can upload a ZIP file that contains your API definitions with dependent files.
  4. Optional: If you uploaded a ZIP file, in the Root file name field, enter the name of the base file that all other API definition files in your zip archive refer to.
  5. Click Import.
    Data from your API definition file appears in the fields on the Register new API page.
    Note: If you’re importing an API definition file to an already existing API configuration and the hostnames or base paths differ from the ones that you previously defined for this configuration, you may proceed with the import in one of the following ways:
    • Import the API definition file and replace the previously defined hostnames and base paths with the new ones.
    • Import the API definition file but keep the previously defined hostnames and base paths. In this case, the system imports all the remaining data included in the file.

    If the system encounters any issues during the import, a yellow banner appears at the top of the page with all issues listed. To learn how to troubleshoot the most common import-related error messages, see API definition import error troubleshooting.