GOgooddata
Test Connection

Test connection by data source definition

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

post/api/v1/actions/dataSource/test

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Request body

authenticationType'USERNAME_PASSWORD' | 'TOKEN' | 'KEY_PAIR' | 'CLIENT_SECRET' | 'OIDC_PASSTHROUGH' nullable

Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).

clientIdstring

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

clientSecretstring

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

passwordstring

Database user password.

privateKeystring

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

privateKeyPassphrasestring

Passphrase for a encrypted version of a private key.

schemastring

Database schema.

tokenstring

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

type'POSTGRESQL' | 'REDSHIFT' | 'VERTICA' | 'SNOWFLAKE' | 'ADS' | 'BIGQUERY' | 'MSSQL' | 'PRESTO' | 'DREMIO' | 'AZURESQL' | 'SYNAPSESQL' | 'DATABRICKS' | 'GDSTORAGE' | 'CLICKHOUSE' | 'MYSQL' | 'MARIADB' | 'ORACLE' | 'PINOT' | 'SINGLESTORE' | 'MOTHERDUCK' | 'FLEXCONNECT' | 'STARROCKS' | 'ATHENA' | 'CRATEDB' | 'AILAKEHOUSE' | 'DENODO' | 'TRINO' required

Type of database, where test should connect to.

urlstring

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

usernamestring

Database user name.

Example request

{
  "password": "admin123",
  "schema": "public",
  "type": "POSTGRESQL",
  "url": "jdbc:postgresql://localhost:5432/db_name",
  "username": "dbadmin"
}

Response

The result of the test of a data source connection.

errorstring

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

successfulboolean required

A flag indicating whether test passed or not.

Example response

{
  "error": "Authentication failed",
  "queryDurationMillis": {
    "createCacheTable": 235,
    "simpleSelect": 562
  },
  "successful": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.