Skip to main content
Version: 5.6

REST Client

With the REST connection, you can access an API to read data.

REST connection

The following properties can be configured for the REST client:

PropertyDescription
NameAny name under which this REST client appears in the connection project. Choose a name that is unique to you during connection project planning.
Host URLURL of the web service to be connected.
OpenAPI fileURL that leads to the description file of the API (programming interface). This is usually a JSON or YAML file. Specifying an OpenAPI file helps later when configuring the transfer object.
LoginIf you need to log in to the web service, you can select the appropriate type here. You can obtain the relevant information from the web service administrator.
HTTP headerFields for the transfer of HTTP parameters.
TimeoutTime in seconds that the connection may take to establish before a connection error is returned.
Trusted certificates

Selection of which certificates should be trusted.

  • All (insecure): Every certificate is accepted.
  • Router: A connection is allowed if the certificate is in the router's certificate management and is trusted.
  • Windows: A connection is allowed if the certificate is present in the Windows certificate store.
CertificateClient certificate to be used for connections. The plus sign is used to add a certificate, the trash can to remove a certificate. The eye icon can be used to view the properties of the selected certificate.