Enter API endpoint details

API endpoints are unique URLs that host API resources. You specify an API endpoint URL by providing a hostname and, optionally, a base path. You can associate multiple hostnames with your API.

How to

  1. Optional: On the Register new API page, in the API base path field, enter the base path on which your API serves content in the following format: /basePath
    where basePath is a URL prefix relative to the host root for all API paths.

    The base path is case-sensitive. This means that, for example, /basePath and /BasePath denote two different API configurations.

    When entering a base path, you can use curly brackets ({}) to define path parameters (for example, /basePath/{pathparam1}). If desired, you can also define multiple path parameters (for example, /basePath/{pathparam1},{pathparam2},{pathparam3}). All path parameters that you define this way automatically appear in the methods that you select for each resource.

    You can use the wildcard (*) sign to indicate a single component between two forward slashes in a base path. Do NOT use wildcards to indicate the following:

    • One or more forward slashes
    • A path component and a forward slash
    • Multiple path components
    • Two separate path components by entering two wildcard signs (**)
    • A path parameter (use curly brackets ({}) instead)
    Important: If you don’t specify a base path, your API will serve content directly from the host and all API resource paths will start at the host root.

    Additionally, the settings and security policies associated with the API configuration with an unspecified base path will apply to all requests to any associated hostname(s), and all settings in the API configuration apart from CORS and GZIP compression will override any corresponding property settings you defined in Property Manager for those hostnames. Unless you use the associated property only for traffic to this API, we recommend you specify a base path.

  2. From the API hostnames menu, select at least one hostname for publishing your API via Akamai.
    Each hostname available for selection has its associated access control group in parentheses.
    Data appears in the API endpoint URL(s) area.
    Important: To avoid conflicts with other web resources, each API endpoint URL must be unique.

What you should see

A sample API endpoint details configuration may look like this:
API endpoint details example