Endpoints

Skip to section
POST/v1/dcaas/actions/data-connections
GET/v1/dcaas/actions/data-connections/{connectionId}
GET/v1/dcaas/actions/data-connections/api-specs

Create a dataconnection against a datasource

manage

Facts POST /v1/dcaas/actions/data-connections

Rate limit
required
Tier 2 (100 requests per minute)

Request Body POST /v1/dcaas/actions/data-connections

application/json

No description

Responses POST /v1/dcaas/actions/data-connections

201
application/json
object

Data connection created

400
application/json

Bad request

401
application/json

Unauthorized request (Bad JWT token etc)

403
application/json

Access forbidden, happens when feature or datasource is not enabled

500
application/json

Internal errors

503
application/json

Service unavailable, happens when request to connector or down stream services fails

POST/v1/dcaas/actions/data-connections

curl "https://your-tenant.us.qlikcloud.com/api/v1/dcaas/actions/data-connections" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"tags":[],"spaceId":"string","authUrlOnly":true,"dataSourceId":"string","connectionName":"string","connectionProperties":{}}'

Request POST /v1/dcaas/actions/data-connections

{
  "tags": [],
  "spaceId": "string",
  "authUrlOnly": true,
  "dataSourceId": "string",
  "connectionName": "string",
  "connectionProperties": {}
}

Get data connection for a given ID

manage

Facts GET /v1/dcaas/actions/data-connections/{connectionId}

Rate limit
required
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/dcaas/actions/data-connections/{connectionId}

connectionId
required
string<uuid>

ID of the connection

Responses GET /v1/dcaas/actions/data-connections/{connectionId}

200
application/yaml

Connection returned

401
application/json

Unauthorized request (Bad JWT token etc)

403
application/json

Access forbidden, happens when feature or datasource is not enabled

404
application/json

Access forbidden, happens when feature or datasource is not enabled

500
application/json

Internal errors

503
application/json

Service unavailable, happens when request to connector or down stream services fails

GET/v1/dcaas/actions/data-connections/{connectionId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/dcaas/actions/data-connections/{connectionId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/dcaas/actions/data-connections/{connectionId}

{
  "tags": [],
  "userId": "string",
  "spaceId": "641c53f71ecb12d7c450f687",
  "tenantId": "string",
  "updateAt": "2023-03-23T13:30:55.351Z",
  "createdAt": "2023-03-23T13:30:55.351Z",
  "connectionId": "44054965-a970-458b-8c82-1fbf2934f87a",
  "dataSourceId": "string",
  "credentialsId": "d24799e4-e872-432b-8c5d-b9012afc6ff7",
  "connectionName": "string",
  "connectionProperties": {}
}

Get 'connectionProperties' for a given datasource

manage

Facts GET /v1/dcaas/actions/data-connections/api-specs

Rate limit
required
Tier 1 (1000 requests per minute)

Query Parameters GET /v1/dcaas/actions/data-connections/api-specs

dataSourceId
required
string

Datasource ID

Responses GET /v1/dcaas/actions/data-connections/api-specs

200
application/yaml

API spec returned

401
application/json

Unauthorized request (Bad JWT token etc)

403
application/json

Access forbidden, happens when feature or datasource is not enabled

500
application/json

Internal errors

503
application/json

Service unavailable, happens when request to connector or down stream services fails

GET/v1/dcaas/actions/data-connections/api-specs

curl "https://your-tenant.us.qlikcloud.com/api/v1/dcaas/actions/data-connections/api-specs" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/dcaas/actions/data-connections/api-specs

{
  "connectionProperties": {},
  "x-qlik-connector-version": "string"
}

ApiSpecResponse

object

Properties

connectionProperties
required
object

List of properties required for the given datasource

x-qlik-connector-version
required
string

Datasource provider (i.e. connector) version

AuthUrlResponse

object

Properties

authUrl
required
string

Authentication URL for OAuth datasource

CreateConnectionReq

object

Properties

tags
Array<string>

string tags (32 or less) persisted with the connection object

spaceId
string

Target connection space ID

authUrlOnly
default=false
boolean

When set to true, authentication URL will be returned for OAuth request to datasource. This property will be ignored if the request is not OAuth or datasource doesn't support OAuth

dataSourceId
required
string

Datasource ID

connectionName
required
string

Connection name

connectionProperties
required
object

List of connection properties required to create dataconnection for a given datasource, which is defined by the response of 'GET /actions/data-connections/api-specs'

CreateConnectionRes

object

Properties

userId
required
string

User ID

spaceId
string

Space ID

tenantId
required
string

Tenant ID

updateAt
required
string

Updated at time stamp

createdAt
required
string

Created at time stamp

connectionId
required
string

Connection ID

dataSourceId
required
string

Datasource ID

credentialsId
string

Credentials ID (if credentials are included in the request)

connectionName
required
string

Connection name

GetConnectionResponse

object

Properties

tags
Array<string>

string tags associated with the connection

userId
required
string

User ID

spaceId
string

Space ID

tenantId
required
string

Tenant ID

updateAt
required
string

Updated at time stamp

createdAt
required
string

Created at time stamp

connectionId
required
string

Connection ID

dataSourceId
required
string

Datasource ID

credentialsId
string

Credentials ID (associated with the connection, either embedded or separated)

connectionName
required
string

Connection name

connectionProperties
required
object

List of connection properties

PublicApiError

object

Properties

code
required
string

A service specific error code string

meta
object

Additional metadata associated with the error

title
required
string

Summary of the error

detail
string

Concrete detail about the error

ResponseErrors

object

Properties

errors

No description

v0.809.0
Was this page helpful?