Table of Contents

Search

  1. Preface
  2. Connectors and connections
  3. Connection configuration
  4. Connection properties
  5. Swagger file generation for REST V2 connections

Connections

Connections

REST V3 Connection Properties

REST V3 Connection Properties

When you set up a REST V3 connection, you must configure the connection properties.
When you create a connection, you can specify the following authentication methods:
  • None. Does not require an authentication method to connect to the REST endpoint.
  • Basic. Requires user ID and password to connect to the REST endpoint.
  • OAuth 2.0 authorization code. Requires an authorization server to connect to the REST endpoint. Authorization Code allows authorized access to the endpoint without sharing or storing your credentials.
  • OAuth 2.0 client credentials. Requires client ID and client secret to connect to the REST endpoint.
The following table describes the REST V3 connection properties for a basic authentication type connection:
Connection property
Description
Runtime Environment
Name of the runtime environment where you want to run the tasks.
Specify a Secure Agent or serverless runtime environment.
Auth Type
The authentication method that the connector must use to connect to the REST endpoint.
Select
Basic
.
Default is None.
Auth User ID
The user name to log in to the web service application when you select the Basic authentication type.
Auth Password
The password associated with the user name when you select the Basic authentication type.
TrustStore File Path
The absolute path of the truststore file that contains the TLS certificate to establish a one-way or two-way secure connection with the REST API.
Ensure that the truststore file is in .jks format. Specify a directory path that is available on each Secure Agent machine in the runtime environment.
TrustStore Password
The password for the truststore file that contains the SSL certificate.
KeyStore File Path
The absolute path of the keystore file that contains the keys and certificates required to establish a two-way secure communication with the REST API.
Ensure that the keystore file is in .jks format. Specify a directory path that is available on each Secure Agent machine in the runtime environment.
KeyStore Password
The password for the keystore file required for secure communication.
Proxy Type
Type of proxy.
You can select one of the following options:
  • None. Bypasses the proxy server configured at the agent or the connection level.
  • Custom. Considers proxy configured at the connection level.
  • Platform. Considers proxy configured at the agent level.
Proxy is not applicable when you use the serverless runtime environment.
Proxy Host
The IP address or host name of the proxy server.
Required only for the Custom proxy type.
Proxy Port
The port number of the proxy server.
Required only for the Custom proxy type.
Proxy User
The user name for the proxy server.
Required only for the Custom proxy type.
Proxy Password
The password for the proxy server.
Required only for the Custom proxy type.
Connection Timeout
The wait time in seconds to get a response from a REST endpoint. The connection ends after the connection timeout is over.
Default is 60 seconds.
If you define both the REST V3 connection timeout and the endpoint API timeout, the connection ends at the shortest defined timeout.
Retry Attempts
Number of times to retry the connection when 100, 300, 400, and 500 series error codes are returned in the response.
Default is 0. Specify 0 to disable the retry attempts.
In case of 408 error code, silent retries are attempted. Therefore, the number of retry attempts can be more than the value you specify.
Retry Delay
The wait time in seconds before a retry is attempted. Default is 0.
HTTP version
The HTTP version to connect to the REST endpoint.
You can select one of the following options:
  • HTTP 2
  • HTTP 1.1
Default is HTTP 2.

0 COMMENTS

We’d like to hear from you!