Create and manage data connections to various data sources in Qlik Cloud.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/data-connections-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"info": {
"title": "data-connections",
"version": ""
},
"paths": {
"/api/v1/data-connections": {
"get": {
"tags": [
"data-connections"
],
"summary": "Gets a list of connections",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Connections"
}
}
},
"description": "List connections with optional filter queries. Connections will be filtered internally based on the space access rules applicable to the caller. When some of connections are not returned due to errors, errors array in the response will be set."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Bad request, typically when dataName is empty"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Internal error, this happens when the service fails to make requests to dependency services"
},
"502": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Bad gateway, this happens when requests to required (dependent) services time out"
}
},
"parameters": [
{
"$ref": "#/components/parameters/dataName"
},
{
"$ref": "#/components/parameters/extended"
},
{
"$ref": "#/components/parameters/spaceID"
},
{
"$ref": "#/components/parameters/personal"
},
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/ownedbyme"
},
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/sort"
},
{
"$ref": "#/components/parameters/page"
},
{
"$ref": "#/components/parameters/nodatafiles"
},
{
"$ref": "#/components/parameters/userId"
},
{
"$ref": "#/components/parameters/caseinsensitive"
},
{
"$ref": "#/components/parameters/locale"
},
{
"$ref": "#/components/parameters/includeQris"
},
{
"$ref": "#/components/parameters/filter"
},
{
"$ref": "#/components/parameters/includeDisabled"
}
],
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"data-connections"
],
"summary": "Creates a new connection. Depending on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ConnectionCreateResponse"
},
{
"$ref": "#/components/schemas/DcaasConnectionCreateAuthResponse"
}
]
}
}
},
"description": "Data connection created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Invalid data connection specified"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "User has no access to the connection or space"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Credentials referenced by qCredentialsID in the request body could not be found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Data connection already exists"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ConnectionCreate"
},
{
"$ref": "#/components/schemas/DcaasConnectionCreate"
}
]
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-connections/{qID}": {
"get": {
"tags": [
"data-connections"
],
"summary": "Retrieves a connection by connection ID, or by name when the query parameter \"type\" is set to \"connectionname.\"",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionGet"
}
}
},
"description": "Data connection retrieved"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "The qID is not a valid UUID"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "User has no access to the connection or space"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Data connection not found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Credential decryption failed, likely due to invalid credentials"
}
},
"parameters": [
{
"$ref": "#/components/parameters/extended"
},
{
"$ref": "#/components/parameters/qConnID"
},
{
"$ref": "#/components/parameters/type"
},
{
"$ref": "#/components/parameters/credentialID"
},
{
"$ref": "#/components/parameters/bycredentialname"
},
{
"$ref": "#/components/parameters/spaceID"
},
{
"$ref": "#/components/parameters/nocache"
},
{
"$ref": "#/components/parameters/parseConnection"
}
],
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"patch": {
"tags": [
"data-connections"
],
"summary": "Patches a connection specified by connection ID (or by name when type=connectionname is set in query).",
"responses": {
"204": {
"description": "Data connection updated successfully"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Bad request due to invalid data in body"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "User has no access to the connection or space"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Data connection not found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Data connection already exists (when updated name conflicts with existing record)"
}
},
"parameters": [
{
"$ref": "#/components/parameters/qConnID"
},
{
"$ref": "#/components/parameters/type"
},
{
"$ref": "#/components/parameters/authCodeInHeader"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchRequest"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"put": {
"tags": [
"data-connections"
],
"summary": "Updates a connection specified by connection ID (or by name when type=connectionname is set in query). Depends on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.",
"responses": {
"204": {
"description": "Data connection updated successfully"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Bad request due to invalid data in body"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "User has no access to the connection or space"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Data connection not found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Data connection already exists (when updated name conflicts with existing record)"
}
},
"parameters": [
{
"$ref": "#/components/parameters/qConnID"
},
{
"$ref": "#/components/parameters/type"
},
{
"$ref": "#/components/parameters/spaceID"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionUpdate"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"data-connections"
],
"summary": "Deletes the specified data connection by ID (or by name when type=connectionname is set in query)",
"responses": {
"204": {
"description": "Data connection deleted successfully"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "User has no access to the connection or space"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Data connection not found"
}
},
"parameters": [
{
"$ref": "#/components/parameters/qConnID"
},
{
"$ref": "#/components/parameters/type"
},
{
"$ref": "#/components/parameters/spaceID"
}
],
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-connections/actions/delete": {
"post": {
"tags": [
"data-connections"
],
"summary": "Delete multiple connections, only available to Admin",
"responses": {
"207": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkResponse"
}
}
},
"description": "Bulk delete completed"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Bad request (Missing required field in request body)"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "User has no access to the endpoint. The endpoint requires Admin role"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionDeleteRequest"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-connections/actions/duplicate": {
"post": {
"tags": [
"data-connections"
],
"summary": "Duplicate a connection",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionCreateResponse"
}
}
},
"description": "Duplicate completed"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Bad request (Missing required field in request body, or duplicate from / to a reserved connection)"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "User has no access to the source connection or no access to target space"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Connection defined by id not found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Duplicated connection would result in a name conflict with the connections in the scope"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionDuplicateRequest"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-connections/actions/update": {
"post": {
"tags": [
"data-connections"
],
"summary": "Update multiple connections, only available to Admin. When update is to change ownership of a connection, the credentials associated with the connection will NOT be transferred to the new owner, and new owner is expected to provide their own credentials for the connection.",
"responses": {
"207": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkResponse"
}
}
},
"description": "Bulk update completed"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "Bad request (Missing required field in request body)"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrors"
}
}
},
"description": "User has no access to the endpoint. The endpoint requires Admin role"
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionUpdateRequest"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
}
},
"openapi": "3.0.0",
"components": {
"parameters": {
"authCodeInHeader": {
"in": "header",
"name": "qlik-auth-code",
"schema": {
"type": "string",
"example": "code=aPrxxWbemCeRRVGEJVgYDAkU_TzTKE6Geu9..."
},
"required": false,
"description": "OAuth authentication code. This header is required by certain datasources when patching a data connection."
},
"bycredentialname": {
"in": "query",
"name": "byCredentialName",
"schema": {
"type": "boolean"
},
"example": false,
"required": false,
"description": "If set to true, credentialId in the query will be interpreted as credential's name"
},
"caseinsensitive": {
"in": "query",
"name": "caseinsensitive",
"schema": {
"type": "boolean",
"example": false
},
"example": true,
"required": false,
"description": "Sort results will be returned in case insensitive order if set to true (Only used along with sort query)"
},
"credentialID": {
"in": "query",
"name": "credentialId",
"schema": {
"type": "string"
},
"example": "22379dc5-076e-4fec-ae20-5529a8a57dc2",
"required": false,
"description": "Credential ID"
},
"dataName": {
"in": "query",
"name": "dataName",
"schema": {
"type": "string"
},
"example": "data",
"required": false,
"description": "Provides an alternate name to be used for data[] element in GET response."
},
"extended": {
"in": "query",
"name": "extended",
"schema": {
"type": "boolean"
},
"example": false,
"required": false,
"description": "Returns extended list of properties (e.g. encrypted credential string) when set to true."
},
"filter": {
"in": "query",
"name": "filter",
"schema": {
"type": "string",
"example": "qName co \"abc\" or qName sw \"dd\" and qType eq \"rest\" and created gt \"2000-01-10T15:04:05Z\""
},
"required": false,
"description": "Filtering resources by properties (filterable properties only) using SCIM filter string. Note the filter string only applies to connections managed by data-connections service, i.e. filtering doesn't apply to DataFile connections. When filtering on datetime property (e.g. created, updated), datetime should be in RFC3339 format."
},
"includeDisabled": {
"in": "query",
"name": "includeDisabled",
"schema": {
"type": "boolean"
},
"example": true,
"required": false,
"description": "Includes connections that uses disabled datasources"
},
"includeQris": {
"in": "query",
"name": "includeQris",
"schema": {
"type": "boolean"
},
"example": true,
"required": false,
"description": "Base Qri (encrypted) will be returned when the query is set to true, default is false"
},
"limit": {
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32",
"default": "All resources will be returned if limit is not defined",
"maximum": 100,
"minimum": 1
},
"example": 30,
"required": false,
"description": "Number of resources to be returned (between 1 and 100)"
},
"locale": {
"in": "query",
"name": "locale",
"schema": {
"type": "string"
},
"example": "en",
"required": false,
"description": "ICU locale ID, used only when caseinsensitive is set to true, default to 'en' if undefined"
},
"nocache": {
"in": "query",
"name": "noCache",
"schema": {
"type": "boolean"
},
"example": false,
"required": false,
"description": "datafiles connections will be returned from cache by default (if data-connections is configured to use cache), this query parameter is used disable this default behavior, e.g. return an update-to-date datafiles connection if the query is set to true"
},
"nodatafiles": {
"in": "query",
"name": "noDatafiles",
"schema": {
"type": "boolean"
},
"example": true,
"required": false,
"description": "Datafiles connections will not be returned if set to true"
},
"ownedbyme": {
"in": "query",
"name": "ownedByMe",
"schema": {
"type": "boolean"
},
"example": true,
"required": false,
"description": "Filtering on connections, return connections owned by the caller if set to true (doesn't apply to datafiles connections)"
},
"owner": {
"in": "query",
"name": "owner",
"schema": {
"type": "string"
},
"example": "928e2a66-01ba-4678-aa32-e74c213896fa",
"required": false,
"description": "Filtering on datafile connections by owner (i.e. app) ID."
},
"page": {
"in": "query",
"name": "page",
"schema": {
"type": "string"
},
"example": "page=JwAAAAljcmVhdGVkAPfQ-sx0AQAAB19pZABfb93nZcM4SN1M0e8A",
"required": false,
"description": "Pagination cursor string, which is generated automatically in previous pagination query."
},
"parseConnection": {
"in": "query",
"name": "parseConnection",
"schema": {
"type": "boolean",
"example": true
},
"example": true,
"required": false,
"description": "List of connection properties shall be returned when the query is set to true, default is false"
},
"personal": {
"in": "query",
"name": "personal",
"schema": {
"type": "boolean"
},
"example": false,
"required": false,
"description": "Filtering on personal connections, ignored if spaceId is defined in same request"
},
"qConnID": {
"in": "path",
"name": "qID",
"schema": {
"type": "string"
},
"example": "82ee7b44-0c4d-491b-bd38-82640c0430a5",
"required": true,
"description": "Connection ID"
},
"sort": {
"in": "query",
"name": "sort",
"schema": {
"type": "string"
},
"example": "+qName",
"required": false,
"description": "Name of field sort on for pagination, with prefix with + or - indicating ascending or descending order. When used for data-connections, sort field only applies to non-datafiles connections. Whatever sorting order is, datafiles connections will be returned after all regular connections being returned."
},
"spaceID": {
"in": "query",
"name": "spaceId",
"schema": {
"type": "string"
},
"example": "611bcebaeec1203d88211ac4",
"required": false,
"description": "Filtering on connections by space ID"
},
"type": {
"in": "query",
"name": "type",
"schema": {
"enum": [
"connectionname"
],
"type": "string"
},
"example": "connectionname",
"required": false,
"description": "The connection ID in the path becomes a connection name when this query parameter is set."
},
"userId": {
"in": "query",
"name": "userId",
"schema": {
"type": "string"
},
"example": "6K9xjsItDexffolu5vg1oWYkY8x7f-0G",
"required": false,
"description": "Filtering on userId. Requires admin role if specified userId doesn't match that is defined in JWT."
}
},
"schemas": {
"ActionDeleteRequest": {
"type": "object",
"required": [
"connections"
],
"properties": {
"connections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"example": "b2c1ab1f-392c-4cd1-87bd-4c3cd256f5fd",
"description": "ID of connection"
},
"name": {
"type": "string",
"example": "MyConnection",
"description": "Connection name"
}
}
}
}
}
},
"ActionDuplicateRequest": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"example": "b2c1ab1f-392c-4cd1-87bd-4c3cd256f5fd",
"description": "ID of the source connection being duplicated"
},
"name": {
"type": "string",
"example": "ResourceName",
"description": "Optional name for the duplicated connection, must be unique in the target scope. If not specified, a name will be automatically generated"
},
"spaceId": {
"type": "string",
"example": "611bcebaeec1203d88211ac4",
"description": "Optional target space ID for the duplicated connection. If not specified, the duplicated connection will be in the same space as the source connection"
},
"qPassword": {
"type": "string",
"example": "Password",
"description": "Optional credential password, specify to override credential embedded (or associated) with the source connection"
},
"qUsername": {
"type": "string",
"example": "UserName",
"description": "Optional credential username, specify to override credential embedded (or associated) with the source connection"
}
}
},
"ActionUpdateRequest": {
"type": "object",
"required": [
"connections"
],
"properties": {
"connections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"example": "b2c1ab1f-392c-4cd1-87bd-4c3cd256f5fd",
"description": "Connection ID"
},
"name": {
"type": "string",
"example": "MyConnection",
"description": "Connection name"
},
"ownerId": {
"type": "string",
"example": "6K9xjsItDexffSlu5vg1oWYkY8x7f-06",
"description": "User ID to which the connection will be updated. If not present, the connection's owner wont be changed"
},
"spaceId": {
"type": "string",
"example": "611bcebaeec1203d88211ac4",
"description": "Space ID to which the connection will be updated. If not present, the connection's space wont be changed. If it is empty string, then the connection will be moved to the personal space of the user identified by ownerId (If ownerId is undefined, then the connection will be in oroginal owner's personal space)"
},
"spaceType": {
"enum": [
"personal",
"shared",
"managed",
"data"
],
"type": "string",
"example": "personal",
"description": "Space type. Required when spaceId is specifi
# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-data-connections.json