Organization
Users and User Groups
Permissions
Data Source
    Data Source - Declarative APIs
    Data Source - Entity APIs
    Test Connection
      Test connection by data source definitionpostTest data source connection by data source idpost
    Invalidate Cache
    Manage Permissions
    Available Drivers
    Scanning
    Data source files import
    Data source files analysis
    Data source staging location
    Data source files listing
    Data source files deletion
    Data source files manifest read
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Test Connection (3.51)

Endpoint:/

Test connection by data source definition

POST
/api/v1/actions/dataSource/test

Test if it is possible to connect to a database using a connection provided by the data source definition in the request body.

Test connection by data source definition › Request Body

  • typestring · enum · required

    Type of database, where test should connect to.

    Enum values:
    POSTGRESQL
    REDSHIFT
    VERTICA
    SNOWFLAKE
    ADS
    BIGQUERY
    MSSQL
    PRESTO
    Example: POSTGRESQL
  • clientIdstring

    Id for client based authentication for data sources which supports it.

  • clientSecretstring

    Secret for client based authentication for data sources which supports it.

  • parametersobject[]
  • passwordstring

    Database user password.

    Example: admin123
  • privateKeystring

    Private key for data sources which supports key-pair authentication.

  • privateKeyPassphrasestring

    Passphrase for a encrypted version of a private key.

  • schemastring

    Database schema.

    Example: public
  • tokenstring

    Secret for token based authentication for data sources which supports it.

  • urlstring

    URL to database in JDBC format, where test should connect to.

    Example: jdbc:postgresql://localhost:5432/db_name
  • usernamestring

    Database user name.

    Example: dbadmin

Test connection by data source definition › Responses

The result of the test of a data source connection.

  • successfulboolean · required

    A flag indicating whether test passed or not.

    Example: true
  • errorstring

    Field containing more details in case of a failure. Details are available to a privileged user only.

    Example: Connection exception: Failed to initialize pool: FATAL: password authentication failed for user "user"
  • queryDurationMillisobject

    A structure containing duration of the test queries run on a data source. It is omitted if an error happens.

POST /api/v1/actions/dataSource/test

Test data source connection by data source id

POST
/api/v1/actions/dataSources/{dataSourceId}/test

Test if it is possible to connect to a database using an existing data source definition.

Test data source connection by data source id › path Parameters

  • dataSourceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

    Data source id

Test data source connection by data source id › Request Body

  • clientIdstring

    Id for client based authentication for data sources which supports it.

  • clientSecretstring

    Secret for client based authentication for data sources which supports it.

  • parametersobject[]
  • passwordstring

    Database user password.

    Example: admin123
  • privateKeystring

    Private key for data sources which supports key-pair authentication.

  • privateKeyPassphrasestring

    Passphrase for a encrypted version of a private key.

  • schemastring

    Database schema.

    Example: public
  • tokenstring

    Secret for token based authentication for data sources which supports it.

  • urlstring

    URL to database in JDBC format, where test should connect to.

    Example: jdbc:postgresql://localhost:5432/db_name
  • usernamestring

    Database user name.

    Example: dbadmin

Test data source connection by data source id › Responses

The result of the test of a data source connection.

  • successfulboolean · required

    A flag indicating whether test passed or not.

    Example: true
  • errorstring

    Field containing more details in case of a failure. Details are available to a privileged user only.

    Example: Connection exception: Failed to initialize pool: FATAL: password authentication failed for user "user"
  • queryDurationMillisobject

    A structure containing duration of the test queries run on a data source. It is omitted if an error happens.

POST /api/v1/actions/dataSources/{dataSourceId}/test
Data Source - Entity APIsInvalidate Cache