Connections

Back Next

REST V2 connection properties

When you set up a REST V2 connection, you must configure the connection properties.

The following table describes the REST V2 connection properties for a Standard authentication type connection:

Connection property	Description
Connection Name	Name of the connection. Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -, Maximum length is 255 characters.
Description	Description of the connection. Maximum length is 4000 characters.
Type	The REST V2 connection type.
Runtime Environment	Name of the runtime environment where you want to run the tasks. Select a Secure Agent, Hosted Agent, or serverless runtime environment. You cannot run a streaming ingestion task on a Hosted Agent or serverless runtime environment.
Authentication	The authentication method that the REST V2 Connector must use to connect to the REST endpoint. Select Standard .
Authentication Type	The authentication type that you can use when you select the Standard authentication. You can select one of the following authentication types: BASIC DIGEST OAUTH NONE Default is NONE .
Auth User ID	The user name to log in to the web service application when you select the Standard authentication. Digest authentication is not applicable.
Auth Password	The password associated with the user name when you select the Standard authentication. Digest authentication is not applicable.
OAuth Consumer Key	The client key associated with the web service application. Required only for Oauth authentication type.
OAuth Consumer Secret	The client password to connect to the web service application. Required only for Oauth authentication type.
OAuth Token	The access token to connect to the web service application. Required only for Oauth authentication type.
OAuth Token Secret	The password associated with the OAuth token. Required only for Oauth authentication type.
Swagger File Path	The path of the Swagger file or OpenAPI file. You can specify one of the following file paths: Absolute path along with the file name Hosted URL If you provide the absolute path of the Swagger file or OpenAPI file, the file must be located on the Secure Agent machine. The hosted URL must return the content of the file without prompting for further authentication and redirection. For example, the path of the Swagger file can be: C:\Swagger\sampleSwagger.json The user must have the read permission for the folder and the file.
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. Specify a directory path that is available on each Secure Agent machine. You can also configure the truststore file name and password as a JVM option or import the certificate to the following directory: <Secure Agent installation directory\jre\lib\security\cacerts . For the serverless runtime environment, specify the truststore file path in the serverless agent directory. For example, /home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks
TrustStore Password	The password for the truststore file that contains the SSL certificate. You can also configure the truststore password as a JVM option.
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. Specify a directory path that is available on each Secure Agent machine. You can also configure the keystore file name and location as a JVM option or import the certificate to any directory. For the serverless runtime environment, specify the keystore file path in the serverless agent directory. For example, /home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks
KeyStore Password	The password for the keystore file required for secure communication. You can also configure the keystore password as a JVM option.
Proxy Type	Type of proxy. You can select one of the following options: No Proxy. Bypasses the proxy server configured in the agent or the connection properties. Platform Proxy. Considers the proxy configured in the agent. Custom Proxy. Considers the proxy configured in the connection properties.
Proxy Configuration	The format required to configure proxy. You can configure proxy using the following format: <host>:<port> You cannot configure an authenticated proxy server.
Advanced Fields	Enter the arguments that the agent uses when connecting to a REST endpoint. You can specify the following arguments, each separated by a semicolon ( ; ): ConnectionTimeout . The wait time in milliseconds to get a response from a REST endpoint. The connection ends after the connection timeout is over. Default is the timeout defined in the endpoint API. If you define both the REST V2 connection timeout and the endpoint API timeout, the connection ends at the shortest defined timeout. connectiondelaytime . The delay time in milliseconds to send a request to a REST endpoint. Default is 10000. retryattempts . Number of times the connection is attempted when 400 and 500 series error codes are returned in the response. Default is 3. Specify 0 to disable the retry attempts. qualifiedSchema . Determines if the schema selected is qualified or unqualified. Default is false. For example, connectiondelaytime:10000;retryattempts:5 In a streaming ingestion task, only ConnectionTimeout and retryattempts are applicable.