Creating an Endpoint Alias

Edit online

You must have the webMethods API Gateway's manage aliases functional privilege assigned to perform this task.

An endpoint alias stores the endpoint value along with additional properties such as connection timeout, read timeout, whether to pass security headers or not, keystore alias, key alias, and so on.

To create an endpoint alias

  1. Expand the menu options icon user menu, in the title bar, and select Aliases.
  2. Click Create alias.
  3. In the Basic information section, provide the following information:
    Field Description
    Name Name of the alias.
    Type Select Endpoint alias.
    Description Description of the alias.
  4. Click Technical information and provide the following information:
    Field Description
    Optimization technique This is applicable only for a SOAP API.
    Specify the optimization technique for the SOAP request received. Select any one of the following:
    • None. This is the default value. webMethods API Gateway does not use any optimization method to parse the SOAP requests to the API.
    • MTOM. Indicates that webMethods API Gateway expects to receive a request with a Message Transmission Optimization Mechanism (MTOM) attachment and forwards the attachment to the native service.
    • SWA. Indicates that webMethods API Gateway expects to receive a SOAP with Attachment (SWA) request and forwards the attachment to the native service.
    Pass WS-Security Headers Passes the security header.
    Endpoint URI Specify the default URI or components of the URI such as service name.
    Connection timeout Specify the time interval (in seconds) after which a connection attempt times out.

    If the Connection timeout value is not specified, it defaults to 30.

    The precedence of the Connection Timeout configuration is as follows:

    1. If you specify a value for the Connection timeout field in routing endpoint alias, then the Connection timeout value specified in the Endpoint alias section takes precedence over the timeout values defined at the API level and the global level.
    2. If you specify a value 0 for the Connection timeout field in routing endpoint alias, then webMethods API Gateway uses the value specified in the Connection timeout field in the routing protocol processing step of an API. The Read Timeout value specified at an API level takes precedence over the global configuration.
    3. If you specify a value 0 or do not specify a value for the Connection timeout field in the routing protocol processing step at the API level or specify a value 0 at an alias level, then webMethods API Gateway uses the value specified in this pg.endpoint.connectionTimeout property.
    4. If you do not specify any value for pg.endpoint.connectionTimeout, then webMethods API Gateway uses the default value of 30 seconds.
    Read timeout Specify the time interval (in seconds) after which a socket read attempt times out.

    If the Read timeout value is not specified, it defaults to 30.

    The precedence of the Read Timeout configuration is as follows:

    1. If you specify a value for the Read timeout field in routing endpoint alias, then the Read timeout value specified in the Endpoint alias section takes precedence over the timeout values defined at the API level and the global level.
    2. If you specify a value 0 for the Read timeout field in routing endpoint alias, then webMethods API Gateway uses the value specified in the Read Timeout field in the routing protocol processing step of an API. The Read Timeout value specified at an API level takes precedence over the global configuration.
    3. If you specify a value 0 or do not specify a value for the Read timeout field in the routing protocol processing step at the API level or specify a value 0 at an alias level, then webMethods API Gateway uses the value specified in this pg.endpoint.readTimeout property.
    4. If you do not specify any value for pg.endpoint.readTimeout, then webMethods API Gateway uses the default value of 30 seconds.
    Native service timeout

    Specifies the time interval (in seconds) after which an HTTP connection attempt when calling the Integration Server HTTP backend service pub.client:http for REST APIs times out.

    The precedence of the Native Service Timeout configuration is as follows.

    1. If you specify a value for the Native Service Timeout field in routing endpoint alias, then the Native Service Timeout value specified in the Endpoint alias section takes precedence over the timeout values defined at the API level and the global level.
    2. If you specify a value 0 or blank for the Native Service Timeout field in routing endpoint alias, then webMethods API Gateway uses the value specified in the Native Service Timeout field in the routing protocol processing step of an API. The Native Service Timeout value specified at an API level takes precedence over the global configuration.
    3. If you specify a value 0 or do not specify a value for the Native Service Timeout field in the routing protocol processing step at the API level or specify a value 0 at an alias level, then webMethods API Gateway uses the value specified in this pg.endpoint.nativeServiceTimeout property.
    4. If you do not specify any value for pg.endpoint.nativeServiceTimeout, then webMethods API Gateway disables the native service timeout.

    When a native service timeout is defined for an API, both the connection timeout and the read timeout values are set to the value of the native service timeout during the connection process to the native service.
    Keystore alias Specifies the keystore alias configured in webMethods API Gateway. This value (along with the value of Client Certificate Alias) is used for performing SSL client authentication.

    Lists all available keystores. If you have not configured any keystore, the list is empty.

    Key alias Specifies the alias for the private key, which must be stored in the keystore specified by the keystore alias.
    Truststore alias Specifies the alias for the truststore that contains the list of CA certificates that API Gateway uses to validate the trust relationship with the native API.

    If you do not configure any truststore alias, it implies that webMethods API Gateway does not validate the certificates provided by native APIs.

    Stage Specify a stage, if you want the alias to be applicable to a specific stage.
  5. Click Save.