Creating URL Alias

Edit online

When you create a URL alias, you create an association between an alias and an API on webMethods API Gateway.

Keep the following information in mind when creating a URL alias:

  • An alias name must be unique across webMethods API Gateway.
  • You can associate a single URL alias with multiple resources by specifying port mappings. A port mapping correlates the alias with a different URL alias based on the port on which the request was received.
  • If you want to use URL alias with a REST resource you must enable partial matching of URL aliases.
  • If you enabled or intend to enable partial matching of URL aliases, do not define an alias that begins with another alias.

To create a URL alias

  1. Expand the menu options icon menu_options, in the title bar, and select Administration.
  2. Select General > URL aliases.
    This displays a list of available URL aliases and the corresponding details.
  3. Click Add URL alias and provide the following information:
    Field Description
    Alias The alias name of the proxy server.

    An alias name must be unique across webMethods API Gateway.

    The alias name cannot include a space, nor can it include the following characters: # % ? ' " < \

    The alias name cannot begin with the string http:// or https://

    Port number The port number to use when accessing the API.

    When webMethods API Gateway receives a request that contains a URL alias, webMethods API Gateway resolves the request destination by first determining if there is a URL path associated with the incoming port. If there is no URL path mapped to the port number, then webMethods API Gateway uses the default URL path for the alias as the request destination. The port mappings are always evaluated first.

    Because the URL path can be different for each port, using port mappings allows the use of a single URL alias with multiple destinations. Each port can have only one URL path mapping. You can add port mappings to multiple destinations by clicking the +Add button.

    URL path The URL path for the URL alias and for port number mapped for the URL alias.

    The URL path cannot include a space or the following characters: # % ? ’ “ < \

    Default URL path The URL path to the API on webMethods API Gateway.

    You must specify the default URL path if you do not define any port mappings for the URL alias. If the URL alias includes port mappings, the Default URL Path field is optional.

    The URL path cannot include a space or the following characters: # % ? ’ “ < \

  4. Click Save.