Enter API version details

For each API that you register with Akamai, you can specify a version value and the location of the version value in incoming requests.

How to

  1. Optional: On the Register new API page, in the API version location field, select the location where the details about your API version are stored.
    This can either be a base path (for example, /api/v1/users), query string (for example, /api/users?version=1), or header. You can either use a custom HTTP header to indicate the version (for example, API-Version: 1), or the Accept header to indicate the version together with the acceptable content-type (for example, Accept: application/vnd.mycompany.myapp-v2+xml).
  2. Follow one of these steps:
    Note: You may use wildcards (*) to broaden the number of acceptable version values. For example, in the Accept header case, you may allow API consumers to send requests of any content type: application/*; version=1. In the base path case, you may allow all requests regardless of the version: api/v*/
    If...Then...
    If you selected Base path for the API version location, then enter the version value in the Base path field.

    For example: api/v1/

    If you selected Header for the API version location, then do these steps:
    1. In the Header name field, enter the name of the HTTP header that includes the version details.

      For example: API-Version or Accept.

    2. In the API version field, enter the version value included in the HTTP header.

      For example: 1. When you use the Accept header to indicate both the version and the acceptable content type, the value is usually longer and may look like one of the following examples:

      • application/json; version=1
      • application/vnd.myapp.user.v1+json
      • application/vnd.myapp+xml;version=1 application/vnd
    If you selected Query parameter for the API version location, then do these steps:
    1. In the Query param name field, enter the name of the query parameter that includes the version details.

      For example: version

    2. In the API version field, enter the version value included in the query parameter.

      For example: 1 (the full URL with the query parameter could look like this: http://myapp.com/api/?version=1)