Every API here is available over the APIs.io API and to AI agents over MCP.
{
"info": {
"title": "di-projects",
"version": ""
},
"paths": {
"/api/v1/di-projects": {
"get": {
"tags": [
"data project"
],
"summary": "List projects",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListDiProjectsRsp"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad Request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Not Found"
}
},
"parameters": [
{
"in": "query",
"name": "spaceId",
"schema": {
"type": "string"
},
"required": false,
"description": "Filter by space id"
}
],
"description": "List data integration projects.",
"operationId": "list_projects",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"data project"
],
"summary": "Create a new project",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DiProjectItemRsp"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad Request"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal Server Error"
}
},
"description": "Creates a new data integration project in the specified space.",
"operationId": "create_project",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDiProjectReq"
}
}
},
"required": true,
"description": "The details of the project to create"
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/di-projects/{projectId}": {
"get": {
"tags": [
"data project"
],
"summary": "Get a project",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DiProjectItemRsp"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad Request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Not Found"
}
},
"parameters": [
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
}
],
"description": "Get a specific data integration project.",
"operationId": "get_project",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/di-projects/{projectId}/actions/export": {
"post": {
"tags": [
"data project deployment"
],
"summary": "Export a project",
"responses": {
"200": {
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad Request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal Server Error"
}
},
"parameters": [
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
},
{
"in": "header",
"name": "Accept",
"schema": {
"enum": [
"application/octet-stream"
],
"type": "string"
},
"required": false,
"description": "Optional; only 'application/octet-stream' is supported."
}
],
"description": "Exports the specified data integration project.",
"operationId": "export_project",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportDiProjectReq"
}
}
},
"description": "Options for the export process"
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/di-projects/{projectId}/actions/import": {
"post": {
"tags": [
"data project deployment"
],
"summary": "Import a project (JSON zip)",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportDiProjectRsp"
}
}
},
"description": "OK — the JSON-based project was imported successfully."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad Request — for example, if a YAML-based zip is submitted to this endpoint."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Conflict"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal Server Error"
}
},
"parameters": [
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
}
],
"description": "Imports a data integration project synchronously from a legacy JSON-based `.zip` file.\nThis endpoint only accepts zips that contain JSON project files (the legacy format). The import is processed synchronously and completes before the response is returned.\nSubmitting a YAML-based zip to this endpoint returns `400`. To import a YAML-based zip, use `POST /di-projects/{projectId}/actions/import-async` instead.\n",
"operationId": "import_project",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true,
"description": "The ZIP file containing the JSON-based project to import."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/di-projects/{projectId}/actions/import-async": {
"post": {
"tags": [
"data project deployment"
],
"summary": "Import a project asynchronously",
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncActionRsp"
}
}
},
"headers": {
"Location": {
"$ref": "#/components/headers/AsyncActionLocation"
}
},
"description": "The project import has started. Poll the returned `actionId` using `GET /di-projects/actions/{actionId}` to track progress."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad Request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Conflict"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal Server Error"
}
},
"parameters": [
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
}
],
"description": "Imports a data integration project from a `.zip` file and returns an action identifier for tracking the background import operation. Accepts both JSON-based (legacy) and YAML-based project formats, making it the recommended endpoint for deploying YAML-defined pipeline definitions programmatically. Poll the import status using `GET /di-projects/actions/{actionId}`.\n",
"operationId": "import_project_async",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"format": "binary"
}
}
}
}
},
"required": true,
"description": "A `.zip` file containing the project to import. Accepts both JSON-based (legacy) and YAML-based formats."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/di-projects/{projectId}/actions/prepare": {
"post": {
"tags": [
"data project actions"
],
"summary": "Prepare a project",
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncActionRsp"
}
}
},
"headers": {
"Location": {
"$ref": "#/components/headers/AsyncActionLocation"
}
},
"description": "Preparation started"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Invalid request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Project not found"
}
},
"parameters": [
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
}
],
"description": "Prepares the data integration project and its tasks for execution.",
"operationId": "prepare_project",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrepareProjectReq"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/di-projects/{projectId}/actions/validate": {
"post": {
"tags": [
"data project actions"
],
"summary": "Validate project",
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncActionRsp"
}
}
},
"headers": {
"Location": {
"$ref": "#/components/headers/AsyncActionLocation"
}
},
"description": "Validation started"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Invalid request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Project not found"
}
},
"parameters": [
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
}
],
"description": "Validates the data integration project and its tasks.",
"operationId": "validate_project",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateProjectReq"
}
}
},
"required": true
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/di-projects/{projectId}/bindings": {
"get": {
"tags": [
"data project deployment"
],
"summary": "Get project export variables",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDiExportProjectVariablesRsp"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad Request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Not Found"
}
},
"parameters": [
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
},
{
"in": "query",
"name": "recalculate",
"schema": {
"type": "boolean",
"default": true
},
"examples": {
"example": {
"value": true
}
},
"required": false,
"description": "Recalculate the bindings if true, otherwise saved bindings are returned."
}
],
"description": "Retrieves the export variables for a specific data integration project.",
"operationId": "get_project_export_variables",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"put": {
"tags": [
"data project deployment"
],
"summary": "Update project export variables",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDiExportProjectVariablesRsp"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad Request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal Server Error"
}
},
"parameters": [
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
}
],
"description": "Updates the export variables for a specific data integration project.",
"operationId": "update_project_export_variables",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDiExportProjectVariablesReq"
}
}
},
"required": true,
"description": "The details of the export variables to update"
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/di-projects/{projectId}/di-tasks": {
"get": {
"tags": [
"data task"
],
"summary": "List project tasks",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListDataTasksRsp"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad Request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Not Found"
}
},
"parameters": [
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
}
],
"description": "Lists data tasks within a given data integration project.",
"operationId": "list_project_tasks",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}": {
"get": {
"tags": [
"data task"
],
"summary": "Get a project task",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataTaskItemRsp"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad Request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Not Found"
}
},
"parameters": [
{
"in": "path",
"name": "dataTaskId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "task-cYSY"
}
},
"required": true,
"description": "Identifier of the data task."
},
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
}
],
"description": "Get a specific data task within a project.",
"operationId": "get_data_task",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/prepare": {
"post": {
"tags": [
"data task actions"
],
"summary": "Prepare a project task",
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncActionRsp"
}
}
},
"headers": {
"Location": {
"$ref": "#/components/headers/AsyncActionLocation"
}
},
"description": "Preparation started"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Invalid request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task not found"
}
},
"parameters": [
{
"in": "path",
"name": "dataTaskId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "task-cYSY"
}
},
"required": true,
"description": "Identifier of the data task."
},
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
}
],
"description": "Prepares the specified data task for execution.",
"operationId": "prepare_task",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrepareTaskReq"
}
}
},
"required": false
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/recreate-datasets": {
"post": {
"tags": [
"data task actions"
],
"summary": "Recreate task datasets",
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncActionRsp"
}
}
},
"headers": {
"Location": {
"$ref": "#/components/headers/AsyncActionLocation"
}
},
"description": "Started recreating datasets"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Invalid request"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task or project not found"
}
},
"parameters": [
{
"in": "path",
"name": "dataTaskId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "task-cYSY"
}
},
"required": true,
"description": "Identifier of the data task."
},
{
"in": "path",
"name": "projectId",
"schema": {
"type": "string"
},
"examples": {
"example": {
"value": "65424a71c11367914c1e659b"
}
},
"required": true,
"description": "Identifier of the data project."
}
],
"description": "Recreates datasets in the specified data task.",
"operationId": "recreate_task_datasets",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecreateTaskDatasetsReq"
}
}
},
"required": false
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/di-projects/{projectId}/di-tasks/{dataTaskId}/actions/request-reload": {
"post": {
"tags": [
"data task actions"
],
"summary": "Request dataset reload",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReloadRequestResponse"
# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-di-projects.json