Create data connections

Example creation requests

These examples demonstrate how to create analytics data connections. To learn more, review create data connections.

Athena connection

Standard - IAM credentials

This example connects to an athena host directly from Qlik Cloud, using a service OAuth account.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"athena\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"AwsRegion\": \"<REGION>\",
        \"Catalog\": \"<CATALOG>\",
        \"Schema\": \"<SCHEMA>\",
        \"Workgroup\": \"<WORKGROUP>\",
        \"AuthenticationType\": \"IAM Credentials\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD>\",
        \"S3OutputLocation\": \"<OUTPUT_BUCKET>\"
    }
}"

Direct Access Gateway - IAM credentials

This example connects to an athena host via the Qlik Direct Access Gateway, using a service OAuth account.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"DG_athena\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"gatewayInstance\": \"<GATEWAY_ID>\",
        \"AwsRegion\": \"<REGION>\",
        \"Catalog\": \"<CATALOG>\",
        \"Schema\": \"<SCHEMA>\",
        \"Workgroup\": \"<WORKGROUP>\",
        \"AuthenticationType\": \"IAM Credentials\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD>\",
        \"S3OutputLocation\": \"<OUTPUT_BUCKET>\"
    }
}"

AWS S3 connection

File connection (S3 v2) - access key and secret key

Creates a file connection to a bucket named <BUCKET_NAME>.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: Bearer <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"File_AmazonS3ConnectorV2\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"accessKey\": \"<CRED_USERNAME>\",
        \"secretKey\": \"<CRED_PASSWORD>\",
        \"region\": \"<BUCKET_REGION>\",
        \"bucketName\": \"<BUCKET_NAME>\"
    }
}"

File connection (S3 v2) - access key and secret key, new separated credentials

Creates a file connection to a bucket named <BUCKET_NAME>, and creates a new set of credentials <CREDENTIAL_NAME> for the current user. Other users of this connection will need to provide their own credentials.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: Bearer <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"File_AmazonS3ConnectorV2\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"accessKey\": \"<CRED_USERNAME>\",
        \"secretKey\": \"<CRED_PASSWORD>\",
        \"separateCredentials\": \"true\",
        \"credentialsName\": \"<CREDENTIAL_NAME>\",
        \"region\": \"<BUCKET_REGION>\",
        \"bucketName\": \"<BUCKET_NAME>\"
    }
}"

File connection (S3 v2) - access key and secret key, existing separated credentials

Creates a file connection to a bucket named <BUCKET_NAME>, and associates an existing set of credentials <CREDENTIAL_ID> for the current user. Other users of this connection will need to provide their own credentials.

A list of credentials can be retrieved using the data-credentials API.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: Bearer <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"File_AmazonS3ConnectorV2\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"region\": \"<BUCKET_REGION>\",
        \"bucketName\": \"<BUCKET_NAME>\",
        \"separateCredentials\": \"true\",
        \"selectedCredentials\": \"<CREDENTIAL_ID>\"
    }
}"

Metadata connection (S3 v2) - access key and secret key

Creates a metadata connection to a bucket named <BUCKET_NAME>.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: Bearer <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"AmazonS3ConnectorV2\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"accessKey\": \"<CRED_USERNAME>\",
        \"secretKey\": \"<CRED_PASSWORD>\",
        \"region\": \"<BUCKET_REGION>\",
        \"bucketName\": \"<BUCKET_NAME>\"
    }
}"

Google Cloud Storage connection

File connection - service account

Creates a file connection to a bucket named <BUCKET_NAME>.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: Bearer <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"File_GoogleCloudStorageConnector\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"serviceAccountKeyFile\": 
        [
        {
            \"name\": \"mykeyfile.json\",
            \"value\": \"<CRED_CERTIFICATE>\"
        }
    ],
        \"bucketName\": \"<BUCKET_NAME>\"
    }
}"

Metadata connection - service account

Creates a metadata connection to a bucket named <BUCKET_NAME>.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: Bearer <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"GoogleCloudStorageConnector\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"serviceAccountKeyFile\": 
        [
        {
            \"name\": \"mykeyfile.json\",
            \"value\": \"<CRED_CERTIFICATE>\"
        }
    ],
        \"bucketName\": \"<BUCKET_NAME>\"
    }
}"

Databricks connection

Standard - username and password

This example connects to a databricks host directly from Qlik Cloud.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"databricks\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"host\": \"<HOST>\",
        \"port\": \"443\",
        \"Catalog\": \"<CATALOG>\",
        \"Schema\": \"<SCHEMA>\",
        \"HTTPPath\": \"<HTTP_PATH>\",
        \"AuthMech\": \"3\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD>\",
        \"SSL\": \"true\"
    }
}"

Standard - username and password with trusted certificate

This example connects to a databricks host directly from Qlik Cloud.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"databricks\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"host\": \"<HOST>\",
        \"port\": \"443\",
        \"Catalog\": \"<CATALOG>\",
        \"Schema\": \"<SCHEMA>\",
        \"HTTPPath\": \"<HTTP_PATH>\",
        \"AuthMech\": \"3\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD>\",
        \"SSL\": \"true\"
        \"TrustedCerts\": [
            {
                \"name\": \"certificate.pem\",
                \"value\": \"<CERTIFICATE>\"
            }
        ]
    }
}"

Direct Access Gateway - username and password

This example connects to a MySQL host via the Qlik Direct Access Gateway.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"DG_databricks\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"host\": \"<HOST>\",
        \"port\": \"443\",
        \"Catalog\": \"<CATALOG>\",
        \"Schema\": \"<SCHEMA>\",
        \"HTTPPath\": \"<HTTP_PATH>\",
        \"AuthMech\": \"3\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD>\",
        \"SSL\": \"true\"
    }
}"

Google Big Query connection

Standard - service account

This example connects to a GBQ host directly from Qlik Cloud, using a service OAuth account.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"gbq\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"OAuthMechanism\": \"0\",
        \"Email\": \"<EMAIL>\",
        \"Catalog\": \"<CATALOG>\",
        \"KeyFilePath\": [
            {
                \"name\": \"credentials.p12\",
                \"value\": \"<CREDENTIALS>\"
            }
        ],
        \"P12CustomPwd\": \"<CREDENTIAL_PASSWORD>\"
    }
}"

Direct Access Gateway - service account

This example connects to a QBG host via the Qlik Direct Access Gateway, using a service OAuth account.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"DG_gbq\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"gatewayInstance\": \"<GATEWAY_ID>\",
        \"OAuthMechanism\": \"0\",
        \"Email\": \"<EMAIL>\",
        \"Catalog\": \"<CATALOG>\",
        \"KeyFilePath\": [
            {
                \"name\": \"credentials.p12\",
                \"value\": \"<CREDENTIALS>\"
            }
        ],
        \"P12CustomPwd\": \"<CREDENTIAL_PASSWORD>\"
    }
}"

MSSQL connection

Standard - username and password

This example connects to a MSSQL host directly from Qlik Cloud.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"mssql\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"host\": \"<HOST>\",
        \"port\": \"1433\",
        \"database\": \"<DATABASE_NAME>\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD>\"
    }
}"

Direct Access Gateway - username and password

This example connects to a MSSQL host via the Qlik Direct Access Gateway.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"DG_mssql\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"gatewayInstance\": \"<GATEWAY_ID>\",
        \"host\": \"<HOST>\",
        \"port\": \"1433\",
        \"database\": \"<DATABASE_NAME>\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD>\"
    }
}"

MySQL connection

Standard - username and password

This example connects to a MySQL host directly from Qlik Cloud.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"mysql\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"host\": \"<HOST>\",
        \"port\": \"3306\",
        \"database\": \"<DATABASE_NAME>\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD>\"
    }
}"

Direct Access Gateway - username and password

This example connects to a MySQL host via the Qlik Direct Access Gateway.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"DG_mysql\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"gatewayInstance\": \"<GATEWAY_ID>\",
        \"host\": \"<HOST>\",
        \"port\": \"3306\",
        \"database\": \"<DATABASE_NAME>\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD>\"
    }
}"

REST connection

Qlik Cloud - encrypted header token

This example connects to the users endpoint on the current tenant, and applies some endpoint specific limits and sorting. It also allows the withConnection statement which is required for dynamic control of the connection from application load scripts.

When connecting to Qlik Cloud, a header is used for authorization. In this example, you are connecting to the same tenant in which you’re creating the data connection, so you can use the same <ACCESS_TOKEN> for both the data-connections and users APIs. The Authorization header is encrypted using the encrypt attribute.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"rest\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"url\": \"https://<TENANT>/api/v1/users\",
        \"queryParameters\": [
          {
              \"name\": \"sort\",
              \"value\": \"+name\"
          },
          {
              \"name\": \"limit\",
              \"value\": \"50\"
          }
      ],
      \"queryHeaders\": [
          {
              \"name\": \"Authorization\",
              \"value\": \"Bearer <ACCESS_TOKEN>\",
              \"encrypt\": true
          }
      ],
      \"allowWithConnection\": \"true\"
    }
}"

Standard - no auth

This example connects to a REST endpoint with no authentication.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"rest\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"url\": \"<REST_ENDPOINT>\"
    }
}"

Standard - Basic authentication

This example connects to a REST endpoint with basic authentication.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"rest\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"url\": \"<REST_ENDPOINT>\",
        \"serverCertificateValidation\": \"None\",
        \"authSchema\": \"basic\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD\"
    }
}"

Certificate validation - Basic authentication

This example connects to a REST endpoint with basic authentication, and validates the connection certificate matches the one provided.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"rest\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"url\": \"<REST_ENDPOINT>\",
        \"serverCertificateValidation\": \"Custom\",
        \"rootCertificates\": [
            {
                \"name\": \"rootCA.cer\",
                \"value\": \"<CERTIFICATE>\"
            }
        ],
        \"authSchema\": \"basic\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD\"
    }
}"

Certificate validation and mutual SSL/TLS - no auth

This example connects to a REST endpoint, validates the connection certificate matches the one provided, with mutual SSL/TLS.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"rest\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"url\": \"<REST_ENDPOINT>\",
        \"serverCertificateValidation\": \"Custom\",
        \"rootCertificates\": [
            {
                \"name\": \"rootCA.cer\",
                \"value\": \"<CERTIFICATE>\"
            }
        ],
        \"enableMutualSSL\": \"true\",
        \"mutualPfxCertificateFiles\": [
            {
                \"name\": \"certificate.pfx\",
                \"value\": \"<CERTIFICATE_MUTUAL>\"
            }
        ],
        \"mutualPfxCertificateKey\": \"<CERTIFICATE_PASSWORD>\"
    }
}"

Offset pagination - no auth

This example connects to a REST endpoint and passes offset pagination params.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"rest\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"url\": \"<REST_ENDPOINT>\",
        \"PaginationType\": \"Offset\",
        \"OffsetStartField\": \"header-startAt\",
        \"IsOffsetStartFieldHeader\": \"true\",
        \"OffsetStartFieldValue\": \"500\",
        \"OffsetCountFieldName\": \"count\",
        \"OffsetCountValue\": \"1000\",
        \"OffsetTotalPath\": \"root/Total\",
        \"OffsetDataPath\": \"\"
    }
}"

Query params - no auth

This example connects to a REST endpoint with no authentication, and passes two query params.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"rest\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"url\": \"<REST_ENDPOINT>\",
        \"queryParameters\": [
            {
                \"name\": \"Name0\",
                \"value\": \"Value0\"
            },
            {
                \"name\": \"Name1\",
                \"value\": \"Value1\"
            }
        ]
    }
}"

SFTP connection

Standard - public key with username and password

This example connects to a SFTP host using a public key alongside the user and password auth.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"File_FileTransferConnector\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"host\": \"<SFTP_HOSTNAME>\",
        \"sftpPort\": \"<SFTP_PORT>\",
        \"publicKeyAlgorithm\": \"RSA\",
        \"publicKey\": \"<CRED_PUBLIC_KEY>\",
        \"username\": \"<CRED_USERNAME>\",
        \"password\": \"<CRED_PASSWORD>\"
    }
}"

Standard - public key fingerprint with private key

This example connects to AWS Transfer Family’s SFTP service, on host abs.server.transfer.us-east-1.amazonaws.com. It uses a public key fingerprint alongside the full private key and username for auth.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"File_FileTransferConnector\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"host\": \"abs.server.transfer.us-east-1.amazonaws.com\",
        \"sftpPort\": \"22\",
        \"publicKeyAlgorithm\": \"RSA\",
        \"publicKeyFingerprint\": \"<CRED_FINGERPRINT>\",
        \"username\": \"<CRED_USERNAME>\",
        \"privateKey\": [
            {
                \"name\": \"mykey.pem\",
                \"value\": \"<CRED_PRIVATE_KEY>\"
            }
        ]
    }
}"

Standard - public key fingerprint with username and password

This example connects to a SFTP host using a public key fingerprint alongside the user and password auth.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"File_FileTransferConnector\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"host\": \"<SFTP_HOSTNAME>\",
        \"sftpPort\": \"<SFTP_PORT>\",
        \"publicKeyAlgorithm\": \"RSA\",
        \"publicKeyFingerprint\": \"<CRED_FINGERPRINT>\",
        \"username\": \"<CRED_USERNAME>\",
        \"password\": \"<CRED_PASSWORD>\"
    }
}"

Teradata connection

Standard - username and password

This example connects to a Teradata host directly from Qlik Cloud.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"teradata\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"host\": \"<HOST>\",
        \"port\": \"1025\",
        \"db\": \"<DATABASE_NAME>\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD>\"
    }
}"

Direct Access Gateway - username and password

This example connects to a Teradata host via the Qlik Direct Access Gateway.

If you wish to utilize separate credentials for this connection, review the AWS S3 examples.

curl --location "https://<TENANT>/api/v1/data-connections" ^
--header "Content-Type: application/json" ^
--header "Authorization: <ACCESS_TOKEN>" ^
--data "{
    \"dataSourceId\": \"DG_teradata\",
    \"qName\": \"<CONNECTION_NAME>\",
    \"space\": \"<SPACE_ID>\",
    \"connectionProperties\": {
        \"gatewayInstance\": \"<GATEWAY_ID>\",
        \"host\": \"<HOST>\",
        \"port\": \"1433\",
        \"db\": \"<DATABASE_NAME>\",
        \"username\": \"<USERNAME>\",
        \"password\": \"<PASSWORD>\"
    }
}"

Example creation requests

Create data connections

Example creation requests

Athena connection

AWS S3 connection

Google Cloud Storage connection

Databricks connection

Google Big Query connection

MSSQL connection

MySQL connection

REST connection

SFTP connection

Teradata connection

ON THIS PAGE