Using Integration Server REST API in multi-tenancy scenarios

January 10, 2024

ID 199331

Interaction with the Integration Server REST API is based on requests and responses and is carried out over the HTTPS protocol using the multitenancy account.

Account parameters are passed as the following string {username}:{password} at every method call in the Authorization request header and are encoded with the Base64 method. Authentication of the Basic type is used.

The address of the request to the Integration Server REST API consists of the following parts:

https://{Integration Server address}:{Integration Server port}/{method}?{parameters}


  • {Integration Server address} – IP address or fully qualified domain name (FQDN) of the Integration Server.
  • {Integration Server port} – port for connecting to the Integration Server (port 7271 by default).
  • {method} – method to call.
  • {parameters} – method parameters, if any.

For processing requests that are time consuming and run asynchronously, tasks are used. The task is created as an intermediate query result.

In this section:

Methods for working with tenants

Methods for working with reports

Methods for working with tasks

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.