Qlik Reload API
Trigger and manage data reload operations for Qlik Sense apps.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/reloads-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
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.
OpenAPI Specification
{
"info": {
"title": "reloads",
"version": ""
},
"paths": {
"/api/v1/reloads": {
"get": {
"tags": [
"reloads"
],
"summary": "Find and return reloads",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Reloads"
}
}
},
"description": "Expected response to a valid request."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Forbidden, the requesting JWT does not allow for retrieval of this reload(error code: RELOADS-003)."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "query",
"name": "appId",
"schema": {
"type": "string"
},
"required": true,
"description": "The UUID formatted string used to search for an app's reload history entries. TenantAdmin users may omit this parameter to list all reload history in the tenant."
},
{
"in": "query",
"name": "filter",
"schema": {
"type": "string"
},
"example": "(status eq \"FAILED\" or status eq \"EXCEEDED_LIMIT\") and partial eq \"false\" and type eq \"chronos\"\n",
"required": false,
"description": "SCIM filter expression used to search for reloads.\nThe filter syntax is defined in RFC 7644 section 3.4.2.2\n\nSupported attributes:\n- status: see #schemas/Status\n- partial: see #schemas/Partial\n- type: see #schemas/Type\n\nSupported operators:\n- eq\n"
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"format": "int32",
"default": 10,
"maximum": 100,
"minimum": 1
},
"required": false,
"description": "The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive)."
},
{
"in": "query",
"name": "log",
"schema": {
"type": "boolean",
"default": false
},
"required": false,
"description": "The boolean value used to include the log field or not, set log=true to include the log field."
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the next page of resources. Provide either the next or prev cursor, but not both."
},
{
"in": "query",
"name": "partial",
"schema": {
"type": "boolean"
},
"required": false,
"description": "The boolean value used to search for a reload is partial or not."
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the previous page of resources. Provide either the next or prev cursor, but not both."
},
{
"in": "query",
"name": "sort",
"schema": {
"enum": [
"creationTime",
"+creationTime",
"-creationTime",
"status",
"+status",
"-status",
"startTime",
"+startTime",
"-startTime",
"endTime",
"+endTime",
"-endTime"
],
"type": "string",
"default": "-creationTime"
},
"required": false,
"description": "The field to sort by, with +/- prefix indicating sort order"
},
{
"in": "header",
"name": "Authorization",
"schema": {
"type": "string"
},
"required": true,
"description": "JWT containing tenant credentials."
}
],
"description": "Finds and returns the reloads that the user has access to.",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"reloads"
],
"summary": "Reload an app",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Reload"
}
}
},
"description": "Expected response to a valid request."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Forbidden, the requesting JWT does not allow for execution of this reload(error code: RELOADS-003) or the reload frequency quota has been met.(error code: RELOADS-013)."
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Too many requests, a pending reload request already exists for this app."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "header",
"name": "Authorization",
"schema": {
"type": "string"
},
"required": true,
"description": "JWT containing tenant credentials."
}
],
"description": "Reloads an app specified by an app ID.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReloadRequest"
}
}
},
"required": true,
"description": "Request body specifying ID of app to be reloaded."
},
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "special",
"limit": 50
}
}
},
"/api/v1/reloads/{reloadId}": {
"get": {
"tags": [
"reloads"
],
"summary": "Get reload record",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Reload"
}
}
},
"description": "Expected response to a valid request."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Forbidden, the requesting JWT does not allow to find or get a reload(error code: RELOADS-003)."
},
"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": "reloadId",
"schema": {
"type": "string"
},
"required": true,
"description": "The unique identifier of the reload."
},
{
"in": "header",
"name": "Authorization",
"schema": {
"type": "string"
},
"required": true,
"description": "JWT containing tenant credentials."
}
],
"description": "Finds and returns a reload record.",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/reloads/{reloadId}/actions/cancel": {
"post": {
"tags": [
"reloads"
],
"summary": "Cancel a reload",
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReloadStatus"
}
}
},
"description": "Reload is being cancelled."
},
"204": {
"description": "Reload has been cancelled."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request."
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Unauthorized, JWT invalid or not provided."
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Forbidden, the requesting JWT does not allow to cancel a reload(error code: RELOADS-003)."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "The specified reload record could not be found."
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Reload is not in a cancellable state."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
}
},
"parameters": [
{
"in": "path",
"name": "reloadId",
"schema": {
"type": "string"
},
"required": true,
"description": "The unique identifier of the reload."
},
{
"in": "header",
"name": "Authorization",
"schema": {
"type": "string"
},
"required": true,
"description": "JWT containing tenant credentials."
}
],
"description": "Cancels a reload that is in progress or has been queued",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "special",
"limit": 50
}
}
}
},
"openapi": "3.0.0",
"components": {
"schemas": {
"Error": {
"type": "object",
"required": [
"code",
"title"
],
"properties": {
"code": {
"type": "string",
"example": "RELOADS-001",
"description": "The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'. "
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
}
}
},
"Errors": {
"type": "object",
"example": {
"errors": [
{
"code": "HTTP-123",
"title": "short error message",
"details": "detailed error message"
}
]
},
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"Href": {
"type": "object",
"example": {
"href": "http://example.com"
},
"properties": {
"href": {
"type": "string",
"format": "uri",
"example": "http://example.com"
}
}
},
"Partial": {
"type": "boolean",
"example": false,
"description": "The boolean value used to present the reload is partial or not."
},
"Reload": {
"type": "object",
"required": [
"id",
"appId",
"tenantId",
"userId",
"type",
"status",
"creationTime"
],
"properties": {
"id": {
"type": "string",
"example": "5be59decca62aa00097268a4",
"description": "The ID of the reload."
},
"log": {
"type": "string",
"example": "ReloadID: 5be59decca62aa00097268a4\\nStarted loading\\n(A detailed script progress log can be downloaded when the reload is finished)\\nApp saved\\nFinished successfully\\n",
"description": "The log describing the result of the latest reload execution from the request."
},
"type": {
"$ref": "#/components/schemas/Type"
},
"appId": {
"type": "string",
"example": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
"description": "The ID of the app."
},
"links": {
"$ref": "#/components/schemas/ReloadLinks"
},
"status": {
"$ref": "#/components/schemas/Status"
},
"userId": {
"type": "string",
"example": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
"description": "The ID of the user who created the reload."
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"endTime": {
"type": "string",
"example": "2020-11-03T17:00:11.865Z",
"description": "The time the reload job finished."
},
"partial": {
"$ref": "#/components/schemas/Partial"
},
"tenantId": {
"type": "string",
"example": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
"description": "The ID of the tenant who owns the reload."
},
"errorCode": {
"type": "string",
"example": "EngineConnectionError",
"description": "The error code when the status is FAILED."
},
"startTime": {
"type": "string",
"example": "2020-11-03T17:00:06.351Z",
"description": "The time the reload job was consumed from the queue."
},
"engineTime": {
"type": "string",
"example": "2020-11-03T17:00:07.048Z",
"description": "The timestamp returned from the Sense engine upon successful reload."
},
"resourceId": {
"$ref": "#/components/schemas/ResourceId"
},
"creationTime": {
"type": "string",
"example": "2020-11-03T17:00:00.164Z",
"description": "The time the reload job was created."
},
"errorMessage": {
"type": "string",
"example": "failed to complete reload: unexpected EOF",
"description": "The error message when the status is FAILED."
},
"resourceType": {
"$ref": "#/components/schemas/ResourceType"
}
}
},
"ReloadLinks": {
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/Href"
}
}
},
"ReloadRequest": {
"required": [
"appId"
],
"properties": {
"appId": {
"type": "string",
"example": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
"description": "The ID of the app to be reloaded."
},
"weight": {
"$ref": "#/components/schemas/Weight"
},
"partial": {
"type": "boolean",
"example": false,
"description": "The boolean value used to present the reload is partial or not"
},
"variables": {
"type": "object",
"example": {
"var1": "value1",
"var2": "value2"
},
"description": "The variables to be used in the load script. Maximum of 20 variables allowed with a maximum length of 256 characters for each name/value.",
"maxProperties": 20,
"additionalProperties": {
"type": "string",
"maxLength": 256
}
},
"resourceId": {
"$ref": "#/components/schemas/ResourceId"
},
"resourceType": {
"$ref": "#/components/schemas/ResourceType"
}
}
},
"Reloads": {
"type": "object",
"required": [
"data",
"links"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Reload"
}
},
"links": {
"$ref": "#/components/schemas/ReloadsLinks"
}
}
},
"ReloadsLinks": {
"allOf": [
{
"$ref": "#/components/schemas/ReloadLinks"
},
{
"type": "object",
"properties": {
"next": {
"$ref": "#/components/schemas/Href"
},
"prev": {
"$ref": "#/components/schemas/Href"
}
}
}
]
},
"ReloadStatus": {
"type": "object",
"properties": {
"status": {
"enum": [
"QUEUED",
"RELOADING",
"CANCELING",
"SUCCEEDED",
"FAILED",
"CANCELED",
"EXCEEDED_LIMIT"
],
"type": "string",
"example": "RELOADING",
"description": "The status of the reload."
}
}
},
"ResourceId": {
"type": "string",
"example": "5be59decca62aa00097268a4",
"description": "The String field identifying the specific resource ID within that service"
},
"ResourceType": {
"enum": [
"api",
"reload-tasks",
"tasks",
"automate"
],
"type": "string",
"example": "api",
"description": "The String field identifying the service type that triggered the reload, e.g. \"api\""
},
"Status": {
"enum": [
"QUEUED",
"RELOADING",
"CANCELING",
"SUCCEEDED",
"FAILED",
"CANCELED",
"EXCEEDED_LIMIT"
],
"type": "string",
"example": "FAILED",
"description": "The status of the reload. There are seven statuses. `QUEUED`, `RELOADING`, `CANCELING` are the active statuses. `SUCCEEDED`, `FAILED`, `CANCELED`, `EXCEEDED_LIMIT` are the end statuses."
},
"Type": {
"enum": [
"hub",
"external",
"chronos",
"automations",
"data-refresh",
"choreographer"
],
"type": "string",
"example": "chronos",
"description": "What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data, choreographer = reload triggered by choreographer."
},
"Weight": {
"type": "integer",
"default": 1,
"maximum": 10,
"minimum": 1,
"description": "The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1.\n",
"x-qlik-stability": "stable",
"x-qlik-visibility": "public"
}
}
},
"servers": [
{
"url": "https://{tenant}.{region}.qlikcloud.com",
"variables": {
"region": {
"default": "us",
"description": "The region the tenant is hosted in"
},
"tenant": {
"default": "your-tenant",
"description": "Name of the tenant that will be called"
}
}
}
]
}