Every API here is available over the APIs.io API and to AI agents over MCP.
{
"info": {
"title": "data-stores",
"version": ""
},
"paths": {
"/api/v1/data-stores": {
"get": {
"tags": [
"data-store"
],
"summary": "Get all data stores.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageDataStore"
}
}
},
"description": "Successful Operation"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The request is in incorrect format."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have valid authentication credentials."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have access to the resource."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The input request conflicts with the current state of the resource."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Requested service is not available."
}
},
"parameters": [
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32",
"default": 20,
"maximum": 100
},
"required": false,
"description": "Page size limit."
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"required": false
},
{
"in": "query",
"name": "projections",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"required": false,
"description": "Comma-separated fields to return in the response."
},
{
"in": "query",
"name": "sort",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": false,
"description": "Comma-separated fields and field start with '-' character sorts the result set in descending order."
}
],
"operationId": "getDataStores",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"data-store"
],
"summary": "Save new data store.",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataStore"
}
}
},
"description": "Created new data store successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The request is in incorrect format."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have valid authentication credentials."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have access to the resource."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The input request conflicts with the current state of the resource."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Requested service is not available."
}
},
"operationId": "saveDataStore",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataStore"
}
}
},
"required": true
},
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"data-store"
],
"summary": "Delete data stores if it does not contain any data-assets.",
"responses": {
"204": {
"description": "Deleted empty data stores."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The request is in incorrect format."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have valid authentication credentials."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have access to the resource."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The input request conflicts with the current state of the resource."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Requested service is not available."
}
},
"operationId": "batchDeleteDataStores",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchIdDto"
}
}
},
"required": true
},
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-stores/{data-store-id}": {
"get": {
"tags": [
"data-store"
],
"summary": "Get data store by ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataStore"
}
}
},
"description": "Successful Operation."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The request is in incorrect format."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have valid authentication credentials."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have access to the resource."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The input request conflicts with the current state of the resource."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Requested service is not available."
}
},
"parameters": [
{
"in": "path",
"name": "data-store-id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "projections",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"required": false,
"description": "Comma-separated fields to return in the response."
}
],
"operationId": "getDataStore",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"patch": {
"tags": [
"data-store"
],
"summary": "Patch data store.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataStore"
}
}
},
"description": "Patched data store successfully."
},
"204": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataStore"
}
}
},
"description": "Patched data store successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The request is in incorrect format."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have valid authentication credentials."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have access to the resource."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The input request conflicts with the current state of the resource."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Requested service is not available."
}
},
"parameters": [
{
"in": "path",
"name": "data-store-id",
"schema": {
"type": "string"
},
"required": true
}
],
"operationId": "patchDataStore",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonPatch"
},
"description": "Array of JSON patch documents as defined by RFC 6902."
}
}
},
"required": true
},
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"put": {
"tags": [
"data-store"
],
"summary": "Update data store.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataStore"
}
}
},
"description": "Updated data store successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The request is in incorrect format."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have valid authentication credentials."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have access to the resource."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The input request conflicts with the current state of the resource."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Requested service is not available."
}
},
"parameters": [
{
"in": "path",
"name": "data-store-id",
"schema": {
"type": "string"
},
"required": true
}
],
"operationId": "updateDataStore",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataStore"
}
}
},
"required": true
},
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-stores/{data-store-ids}/data-assets": {
"get": {
"tags": [
"data-store"
],
"summary": "Get all data assets belonging to the data store(s).",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageDataAsset"
}
}
},
"description": "Successful Operation"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The request is in incorrect format."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have valid authentication credentials."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have access to the resource."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The input request conflicts with the current state of the resource."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Requested service is not available."
}
},
"parameters": [
{
"in": "path",
"name": "data-store-ids",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": true,
"description": "Comma-separated data store IDs or * to include all data stores."
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32",
"default": 20,
"maximum": 100
},
"required": false,
"description": "Page size limit."
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"required": false
},
{
"in": "query",
"name": "projections",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"required": false,
"description": "Comma-separated fields to return in the response."
},
{
"in": "query",
"name": "sort",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": false,
"description": "Comma-separated fields and field start with '-' character sorts the result set in descending order."
}
],
"operationId": "getDataAssets",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"delete": {
"tags": [
"data-store"
],
"summary": "Delete data assets and child data-sets by data-store IDs.",
"responses": {
"204": {
"description": "Deleted data assets successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The request is in incorrect format."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have valid authentication credentials."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have access to the resource."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The input request conflicts with the current state of the resource."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Requested service is not available."
}
},
"parameters": [
{
"in": "path",
"name": "data-store-ids",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": true,
"description": "Comma-separated data store IDs or * to include all data stores."
}
],
"operationId": "deleteDataAssetByDataStoreId",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-stores/{data-store-ids}/data-assets/{data-asset-ids}/data-sets": {
"get": {
"tags": [
"data-store"
],
"summary": "Get all data sets belonging to the data store(s) and data asset(s).",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageDataSet"
}
}
},
"description": "Successful Operation."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The request is in incorrect format."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have valid authentication credentials."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "User does not have access to the resource."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "The input request conflicts with the current state of the resource."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal Server Error."
},
"503": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Requested service is not available."
}
},
"parameters": [
{
"in": "path",
"name": "data-asset-ids",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": true,
"description": "Comma-separated data asset IDs or * to include all data assets."
},
{
"in": "path",
"name": "data-store-ids",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": true,
"description": "Comma-separated data store IDs or * to include all data stores."
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32",
"default": 20,
"maximum": 100
},
"required": false,
"description": "Page size limit."
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"required": false
},
{
"in": "query",
"name": "projections",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"required": false,
"description": "Comma-separated fields to return in the response."
},
{
"in": "query",
"name": "sort",
"schema": {
"type": "array",
"items": {
"type": "string"
# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-data-stores.json