Skip to main content
Version: 5.0

Connection Settings for the api Command

The api command supports using preconfigured connection settings, specified via the connection parameter. To create or edit a connection, navigate to: Main Menu - System Settings - Module Settings - Configuration List:

Config list

To create a new connection, click Create in the top-right corner. To edit an existing connection, select it from the list. Below is an example of a completed connection configuration:

Create config

The table below shows the main connection parameters:

ParameterDescriptionExample Values
Connection NameUnique identifier for the connection configuration (used in api commands as connection parameter)test-connection, example
ServerurlBase endpoint URL for API requestshttp://example.com
Proxy urlProxy server address in host:port or full URL format72.10.160.156:8080, http://72.10.160.156:8080
Select authorization typeThe type of authorization. For Basic, you need to specify a username and password, for ApiKey and Bearer, you need to specify a key. The password and key are stored in the keystore Basic, ApiKey, Bearer
Validation SSLSSL validation using certificatesBasic, ApiKey, Bearer
Host name verificationVerifies certificate hostname matches server URL``Basic, ApiKey, Bearer`
Select SSLEncryption protocol version (default: TLS1.3)SSL3, TLS, TLS1.3
Path to trust storeThe path to the self-signed certificate. If the path to the certificate is specified, then you must specify the Password for the certificate, which will be stored in the keystore/path/to/your/sertificate.jks

Before saving the configuration, it is possible to check the connection.

Check connection