How do I Define Global Gateway Endpoint?

Edit online

This use case explains how to define global gateway endpoint. The global gateway endpoint creates gateway endpoint template for all APIs. Each API inherits this global endpoint in addition to the default and custom endpoints of an API.

The use case starts when you want to define global gateway endpoint and ends when you have created the global gateway endpoint.

Global gateway endpoint is not supported for the APIs that have blank space or special characters in API name or API version.

In order to generate a unique gateway endpoint for each API version, the global gateway endpoint template must use the following variables:
  • ${apiName}
  • ${apiVersion}

Before you begin

Ensure that you have the Manage APIs functional privilege.

To define global gateway endpoint

  1. Expand the menu options icon menu_options, in the title bar, and select Administration.
  2. Select General > URL aliases.
  3. In the Global gateway endpoint section, provide the global gateway endpoint that you want to define across the APIs.
  4. Click Save.
    save_endpoint
    The added global gateway endpoint appears in the Gateway endpoint(s) field of the API details page of all APIs. In addition to the default and API-specific gateway endpoints, you can access your APIs using this global gateway endpoint.
    global_endpoint

    After you have saved the global gateway endpoint, the Export icon export_icon that allows you to export the endpoint appears next to the global endpoint. For information about exporting assets, see Export and Import Assets and Configurations.