Creating or editing an HTTP endpoint

HTTP endpoints provide the connection information that Studio and the Integration Appliance use to connect to an HTTP server. An HTTP endpoint also specifies the connection information so the Integration Appliance can act as HTTP listener.  

  1. In the Create Endpointor Edit Endpointpane, configure the fields as described in the following table.
    Note: Changing the configuration properties of an endpoint affects all orchestrations that use that endpoint in the project as the edits are global, not local.
  2. When finished, if available click Test Connection to confirm that you can connect to the HTTP server.
    Note: The Test Connection button is only available when configuring an endpoint for the HTTP Post Request activity - when Location is set to the Remote Server option.
  3. Click OK.
Table 1.
Field Name Description
Location  
Integration Appliance Receives Request This option specifies that the Integration Appliance is acting as an HTTP listener.

For an HTTP endpoint used with the HTTP Receive Request activity, Location is automatically set to the Integration Appliance Receives Request option.  

Remote Server This option specifies that the Integration Appliance is sending and receiving requests from a remote HTTP server.

For an HTTP endpoint used with the HTTP Post Request activity, Location is automatically set to the Remote Server option.

Host Name Required for the Remote Server option only - Specify the host name or IP address for the HTTP server that this endpoint connects to.
Port For the HTTP Receive Request activity - Specify the port number of the Integration Appliance acting as an HTTP listener.

For the HTTP Post Request activity - Specify the port number of the remote HTTP server.  

Login Description
Log into the Server as an Anonymous User Available for the Remote Server option only. Select this option to connect to the HTTP server anonymously (where a user account is not required).
Log into the Server with User Name and Password Available for the Remote Server option only. Select this option to connect to the HTTP server using a user account. Enter the User Name and Password.
Authentication Allows you to select the type of authentication that the Integration Appliance uses when connecting to a remote server. From the drop-down list, select one of the following authentication options:
  • Basic - Sends the user name and password you specify unencrypted to the server. This authentication schema is the least secure.
  • Digest - Encrypts the user name and password you specify before sending the user name and password to the server. This authentication option is more secure than Basic authentication.
  • NTLM - Requires an instance of NTCredentials to be available for the domain name of the server. This authentication is the most secure authentication option. When you choose the NTLM authentication option, the Integration Appliance authenticates a connection and not a request; therefore, the Integration Appliance authenticates every time a new connection is made. The connection must remain open during the authentication process. You cannot use NTLM to authenticate with both a proxy and server.
    Note: Do not prefix the user name with the domain.
Realm / Domain If you select the Basic or Digest authentication option, specify a realm.

If you select the NTLM authentication option, specify a domain.
User Name   Available for the Remote Server option only - Specify the User Name for the account used to connect to the HTTP Server.
Password Available for the Remote Server option only - Specify the Password for the account used to connect to the HTTP Server.
Security Description
None Select the None option if no security is required.
HTTPS Select the HTTPS option to enable secure HTTP over SSL.  
  • Available for the Integration Appliance Receives Request option only - When server authentication is required, select the Server Certificate Alias Name check box to specify that the Integration Appliance acting as a server should provide a certificate to the client. This certificate is used by the client for authentication and encryption. If this check box is selected, the name of the certificate must be provided. A certificate specified at the activity level with this check box, takes precedence over certificates specified at the Integration Appliance level  using the mgmt ssl CLI command.
  • Available for the Remote Server option only - When client authentication is required, select the Client Certificate Alias Name check box to specify that the Integration Appliance acting as a client should provide a certificate to the HTTP Server. This certificate can be used by the HTTP Server for authentication and encryption. If this check box is selected, the name of the certificate must be provided. A certificate specified at the activity level with this check box, takes precedence over certificates specified at the Integration Appliance level  using the mgmt ssl CLI command.
Note: The certificate specified must be uploaded to and registered on the Integration Appliance before the current project is deployed. For more information, see the CLI Command reference.
Connection Timeout - The following Connection field is available for the Remote Server option only.
Time out after ___ seconds when establishing a connection to the Endpoint. The number of seconds before a timeout occurs between the Integration Appliance attempting to establish a connection to the Endpoint and the time it takes for the endpoint to respond to the connection request. For an HTTP activity, the amount of time the Integration Appliance attempts to establish a connection to the HTTP Server before timing out. A connection timeout is different from an activity timeout because an activity timeout occurs after the connection to the endpoint has already been established. An activity timeout specifies the amount of time in seconds before a timeout occurs between the activity invoking a request on an endpoint and the time it takes the endpoint to respond.  You set the activity timeout in the Retry task of the HTTP Post Request Activity.
Proxy - The following Proxy fields are available for the Remote Server option only.
Login Description
Log into the Server as an Anonymous User Available for the Remote Server option only. Select this option to connect to the HTTP server anonymously (where a user account is not required).
Log into the Server with User Name and Password Available for the Remote Server option only. Select this option to connect to the HTTP server using a user account. Enter the User Name and Password.
Authentication Allows you to select the type of authentication that the Integration Appliance uses when connecting to a remote server. From the drop-down list, select one of the following authentication options:
  • Basic - Sends the user name and password you specify unencrypted to the server. This authentication schema is the least secure.
  • Digest - Encrypts the user name and password you specify before sending the user name and password to the server. This authentication option is more secure than Basic authentication.
  • NTLM - Requires an instance of NTCredentials to be available for the domain name of the server. This authentication is the most secure authentication option as the Integration Appliance authenticates a connection and not a request; therefore, the Integration Appliance authenticates every time a new connection is made. The connection must remain open during the authentication process. You cannot use NTLM to authenticate with both a proxy and server.
    Note: Do not prefix the user name with the domain.
Realm / Domain If you select the Basic or Digest authentication option, specify a realm. If you select the NTLM authentication option, specify a domain.
User Name   Available for the Remote Server option only - Specify the User Name for the account used to connect to the HTTP Server.
Password Available for the Remote Server option only - Specify the Password for the account used to connect to the HTTP Server.
Security Description
None Select the None option if no security is required.
HTTPS Select the HTTPS option to enable secure HTTP over SSL.  
  • Available for the Integration Appliance Receives Request option only - When server authentication is required, select the Server Certificate Alias Name check box to specify that the Integration Appliance acting as a server should provide a certificate to the client. This certificate is used by the client for authentication and encryption. If this check box is selected, the name of the certificate must be provided. A certificate specified at the activity level with this check box, takes precedence over certificates specified at the Integration Appliance level  using the mgmt ssl CLI command.
  • Available for the Remote Server option only - When client authentication is required, select the Client Certificate Alias Name check box to specify that the Integration Appliance acting as a client should provide a certificate to the HTTP Server. This certificate can be used by the HTTP Server for authentication and encryption. If this check box is selected, the name of the certificate must be provided. A certificate specified at the activity level with this check box, takes precedence over certificates specified at the Integration Appliance level  using the mgmt ssl CLI command.
Note: The certificate specified must be uploaded to and registered on the Integration Appliance before the current project is deployed. For more information, see the CLI Command reference.
Connection Timeout - The following Connection field is available for the Remote Server option only.
Time out after ___ second(s) when establishing a connection to the Endpoint. Specifies the amount of time in seconds before a timeout occurs between the Integration Appliance attempting to establish a connection to the endpoint and the time it takes for the endpoint to respond to the connection request. For an HTTP activity, the amount of time the Integration Appliance attempts to establish a connection to the HTTP Server before timing out. A connection timeout is different from an activity timeout because an activity timeout occurs after the connection to the endpoint has already been established. An activity timeout specifies the amount of time in seconds before a timeout occurs between the activity invoking a request on an endpoint and the time it takes the endpoint to respond.  You set the activity timeout in Retry task of the HTTP Post Request Activity.
Host Specifies the host name of the proxy server. This field is required.
Port Specifies the port number to use to connect to the proxy server. This field is required
Username Specifies the username to use for proxy server authentication. This field is optional if your proxy server does not require authentication
Password Specifies the password to use for proxy server authentication. This field is optional if your proxy server does not require authentication.
Note: For some of the fields in the endpoint, you can define configuration properties to supply the values for these fields.  The
icon is displayed when you click in a field that supports a configuration property and a configuration property of the same type has already been configured for the project.