Automations

Automations in Qlik Application Automation are no-code workflows which connect applications together.

Endpoints

GET

/v1/automations
POST

/v1/automations
GET

/v1/automations/{id}
PUT

/v1/automations/{id}
DELETE

/v1/automations/{id}
POST

/v1/automations/{id}/actions/copy
POST

/v1/automations/{id}/actions/disable
POST

/v1/automations/{id}/actions/enable
POST

/v1/automations/{id}/actions/move
GET

/v1/automations/{id}/runs
POST

/v1/automations/{id}/runs
GET

/v1/automations/{id}/runs/{runId}
POST

/v1/automations/{id}/runs/{runId}/actions/export
POST

/v1/automations/{id}/runs/{runId}/actions/retry
POST

/v1/automations/{id}/runs/{runId}/actions/stop
GET

/v1/automations/usage

Retrieves a list of the automations that the requesting user has access to.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	managebuild

Query Parameters

fieldsstring

Allows to select the actual fields to be returned. When no fields are defined, all are returned.

default = ""
filterstring

Allowed filters: name, runMode, lastRunStatus, ownerId
limitinteger

The number of automations to retrieve.

minimum = 1, maximum = 200, default = 100, default = 100
sortstring

The field to sort by, with +- prefix indicating sort order. (?query=-name => sort on the name field using descending order)

Can be one of: "id""name""runMode""state""createdAt""updatedAt""lastRunAt""lastRunStatus""duration""+id""+name""+runMode""+state""+createdAt""+updatedAt""+lastRunAt""+lastRunStatus""-id""-name""-runMode""-state""-createdAt""-updatedAt""-lastRunAt""-lastRunStatus""+duration""-duration"

default = "id"

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  
  format = "uuid"
  
  namestring
  Filterable
  
  statestring
  
  Can be one of: "available""unavailable""disabled"
  
  default = "available"
  
  lastRunobject
  
  Show lastRun properties
  
  idstring
  
  format = "uuid"
  
  errorobject
  
  titlestring
  
  inputsobject
  Experimental
  
  statusstring
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped"
  
  contextstring
  
  The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
  
  metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
  
  stopTimestring
  
  format = "date-time"
  
  createdAtstring
  
  format = "date-time"
  
  isTestRunboolean
  
  startTimestring
  
  format = "date-time"
  
  updatedAtstring
  
  format = "date-time"
  
  isArchivedboolean
  
  expectedInputsobject
  Experimental
  
  scheduledStartTimestring
  
  format = "date-time"
  
  ownerIdstring
  Filterable
  
  runModestring
  Filterable
  
  Can be one of: "manual""scheduled""triggered""webhook"
  
  durationinteger
  Filterable
  
  Duration of the last run, indicated in seconds. Calculated from start and stop times
  
  createdAtstring
  
  format = "date-time"
  
  lastRunAtstring
  
  format = "date-time"
  
  updatedAtstring
  
  format = "date-time"
  
  workspaceobject
  
  The workspace contains the JSON representation of the used blocks
  
  snippetIdsarray of strings
  
  A list of snippets that were detected inside the workspace. This includes snippet blocks that are not connected to other blocks. Order of guids is not guaranteed.
  
  descriptionstring
  
  endpointIdsarray of strings
  
  A list of endpoints that were detected inside the workspace. This includes Endpoints present in blocks which are not connected to other blocks. Order of guids is not guaranteed.
  
  connectorIdsarray of strings
  
  A list of connectors that were detected the workspace. This includes Connectors present in blocks which are not connected to other blocks. Order of guids is not guaranteed.
  
  lastRunStatusstring
  Filterable
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped"
  
  executionTokenstring
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  The URL to a resource request
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  The URL to a resource request

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /v1/automations

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik automation ls

Response

{
  "data": [
    {
      "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
      "name": "string",
      "state": "available",
      "lastRun": {
        "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
        "error": {},
        "title": "string",
        "inputs": {},
        "status": "failed",
        "context": "test_run",
        "metrics": {
          "blocks": [
            {
              "type": "endpointBlock",
              "rxBytes": 18329921,
              "txBytes": 18329921,
              "apiCalls": 40,
              "snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
              "endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
              "connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
            }
          ],
          "network": {
            "rxBytes": 0,
            "txBytes": 0
          },
          "totalApiCalls": 0
        },
        "stopTime": "2021-12-23T12:28:21.000000Z",
        "createdAt": "2021-12-23T12:28:21.000000Z",
        "isTestRun": true,
        "startTime": "2021-12-23T12:28:21.000000Z",
        "updatedAt": "2021-12-23T12:28:21.000000Z",
        "isArchived": true,
        "expectedInputs": {},
        "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
      },
      "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
      "runMode": "triggered",
      "duration": "9001",
      "createdAt": "2021-12-23T12:28:21.000000Z",
      "lastRunAt": "2021-12-23T12:28:21.000000Z",
      "updatedAt": "2021-12-23T12:28:21.000000Z",
      "workspace": {},
      "snippetIds": [
        "e0e720d0-4947-11ec-a1d2-9559fa35801d"
      ],
      "description": "string",
      "endpointIds": [
        "9d94bef0-b28c-11eb-8dba-01593c457362",
        "53a6fb70-b28f-11eb-b601-b545a40867e0"
      ],
      "connectorIds": [
        "0d87808f-27c0-11ea-921c-022e6b5ea1e2",
        "0d86ee8a-27c0-11ea-921c-022e6b5ea1e2"
      ],
      "lastRunStatus": "finished",
      "executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}

Creates a new automation. The requesting user must be assigned the AutomationCreator role.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	managebuild

Request Body

Required

application/json

Automation object to create

application/jsonobject
Show application/json properties
- namestring
- statestring
  
  Can be one of: "available""unavailable""disabled"
  
  default = "available"
- schedulesarray of objects
  
  Show schedules properties
  
  stopAtstring
  
  startAtstring
  
  intervalinteger
  
  time in seconds.
  
  timezonestring
- workspaceobject
  
  The workspace generated by the Qlik Application Automations editor.
- descriptionstring

Responses

201

application/json

Created

application/jsonobject
Show application/json properties
- idstring
  
  format = "uuid"
- namestring
- statestring
  
  Can be one of: "available""unavailable""disabled"
  
  default = "available"
- lastRunobject
  
  Show lastRun properties
  
  idstring
  
  format = "uuid"
  
  errorobject
  
  titlestring
  
  inputsobject
  Experimental
  
  statusstring
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped"
  
  contextstring
  
  The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
  
  metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
  
  stopTimestring
  
  format = "date-time"
  
  createdAtstring
  
  format = "date-time"
  
  isTestRunboolean
  
  startTimestring
  
  format = "date-time"
  
  updatedAtstring
  
  format = "date-time"
  
  isArchivedboolean
  
  expectedInputsobject
  Experimental
  
  scheduledStartTimestring
  
  format = "date-time"
- ownerIdstring
- runModestring
  
  Can be one of: "manual""scheduled""triggered""webhook"
- createdAtstring
  
  format = "date-time"
- lastRunAtstring
  
  format = "date-time"
- schedulesarray of objects
  
  Show schedules properties
  
  idstring
  
  format = "uuid"
  
  stopAtstring
  
  startAtstring
  
  intervalinteger
  
  time in seconds.
  
  timezonestring
  
  lastStartedAtstring
  
  format = "date-time"
- updatedAtstring
  
  format = "date-time"
- workspaceobject
  
  The workspace generated by the Qlik Application Automations editor.
- snippetIdsarray of strings
  
  A list of snippets that were detected inside the workspace. This includes snippet blocks that are not connected to other blocks. Order of guids is not guaranteed.
- descriptionstring
- endpointIdsarray of strings
  
  A list of endpoints that were detected inside the workspace. This includes Endpoints present in blocks which are not connected to other blocks. Order of guids is not guaranteed.
- connectorIdsarray of strings
  
  A list of connectors that were detected the workspace. This includes Connectors present in blocks which are not connected to other blocks. Order of guids is not guaranteed.
- lastRunStatusstring
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped"
- executionTokenstring

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /v1/automations

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string","state":"available","schedules":[{"stopAt":"2022-12-01 00:00:00","startAt":"2022-01-01 00:00:00","interval":30,"timezone":"Europe/Stockholm"}],"workspace":{},"description":"string"}'

const https = require('https')
  const data = JSON.stringify({"name":"string","state":"available","schedules":[{"stopAt":"2022-12-01 00:00:00","startAt":"2022-01-01 00:00:00","interval":30,"timezone":"Europe/Stockholm"}],"workspace":{},"description":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik automation create \
--description="string" \
--name="string" \
--schedules='{"stopAt":"2022-12-01 00:00:00","startAt":"2022-01-01 00:00:00","interval":30,"timezone":"Europe/Stockholm"}' \
--state="available"

Request

{
  "name": "string",
  "state": "available",
  "schedules": [
    {
      "stopAt": "2022-12-01 00:00:00",
      "startAt": "2022-01-01 00:00:00",
      "interval": 30,
      "timezone": "Europe/Stockholm"
    }
  ],
  "workspace": {},
  "description": "string"
}

Response

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "name": "string",
  "state": "available",
  "lastRun": {
    "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
    "error": {},
    "title": "string",
    "inputs": {},
    "status": "failed",
    "context": "test_run",
    "metrics": {
      "blocks": [
        {
          "type": "endpointBlock",
          "rxBytes": 18329921,
          "txBytes": 18329921,
          "apiCalls": 40,
          "snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
          "endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
          "connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
        }
      ],
      "network": {
        "rxBytes": 0,
        "txBytes": 0
      },
      "totalApiCalls": 0
    },
    "stopTime": "2021-12-23T12:28:21.000000Z",
    "createdAt": "2021-12-23T12:28:21.000000Z",
    "isTestRun": true,
    "startTime": "2021-12-23T12:28:21.000000Z",
    "updatedAt": "2021-12-23T12:28:21.000000Z",
    "isArchived": true,
    "expectedInputs": {},
    "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
  },
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "runMode": "triggered",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "lastRunAt": "2021-12-23T12:28:21.000000Z",
  "schedules": [
    {
      "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
      "stopAt": "2022-12-01 00:00:00",
      "startAt": "2021-12-01 00:00:00",
      "interval": 30,
      "timezone": "Europe/Stockholm",
      "lastStartedAt": "2022-01-01T12:28:21.000000Z"
    }
  ],
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "workspace": {},
  "snippetIds": [
    "e0e720d0-4947-11ec-a1d2-9559fa35801d"
  ],
  "description": "string",
  "endpointIds": [
    "9d94bef0-b28c-11eb-8dba-01593c457362",
    "53a6fb70-b28f-11eb-b601-b545a40867e0"
  ],
  "connectorIds": [
    "0d87808f-27c0-11ea-921c-022e6b5ea1e2",
    "0d86ee8a-27c0-11ea-921c-022e6b5ea1e2"
  ],
  "lastRunStatus": "finished",
  "executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1"
}

Retrieves the full definition of an automation. The requesting user must be the owner of the automation.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	managebuild

Query Parameters

fieldsstring

Allows to select the actual fields to be returned. Where the default is all fields

default = ""

Path Parameters

idstring
Required

The unique identifier for the automation.

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  format = "uuid"
- namestring
- statestring
  
  Can be one of: "available""unavailable""disabled"
  
  default = "available"
- lastRunobject
  
  Show lastRun properties
  
  idstring
  
  format = "uuid"
  
  errorobject
  
  titlestring
  
  inputsobject
  Experimental
  
  statusstring
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped"
  
  contextstring
  
  The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
  
  metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
  
  stopTimestring
  
  format = "date-time"
  
  createdAtstring
  
  format = "date-time"
  
  isTestRunboolean
  
  startTimestring
  
  format = "date-time"
  
  updatedAtstring
  
  format = "date-time"
  
  isArchivedboolean
  
  expectedInputsobject
  Experimental
  
  scheduledStartTimestring
  
  format = "date-time"
- ownerIdstring
- runModestring
  
  Can be one of: "manual""scheduled""triggered""webhook"
- createdAtstring
  
  format = "date-time"
- lastRunAtstring
  
  format = "date-time"
- schedulesarray of objects
  
  Show schedules properties
  
  idstring
  
  format = "uuid"
  
  stopAtstring
  
  startAtstring
  
  intervalinteger
  
  time in seconds.
  
  timezonestring
  
  lastStartedAtstring
  
  format = "date-time"
- updatedAtstring
  
  format = "date-time"
- workspaceobject
  
  The workspace generated by the Qlik Application Automations editor.
- snippetIdsarray of strings
  
  A list of snippets that were detected inside the workspace. This includes snippet blocks that are not connected to other blocks. Order of guids is not guaranteed.
- descriptionstring
- endpointIdsarray of strings
  
  A list of endpoints that were detected inside the workspace. This includes Endpoints present in blocks which are not connected to other blocks. Order of guids is not guaranteed.
- connectorIdsarray of strings
  
  A list of connectors that were detected the workspace. This includes Connectors present in blocks which are not connected to other blocks. Order of guids is not guaranteed.
- lastRunStatusstring
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped"
- executionTokenstring

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /v1/automations/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik automation get <automationId>

Response

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "name": "string",
  "state": "available",
  "lastRun": {
    "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
    "error": {},
    "title": "string",
    "inputs": {},
    "status": "failed",
    "context": "test_run",
    "metrics": {
      "blocks": [
        {
          "type": "endpointBlock",
          "rxBytes": 18329921,
          "txBytes": 18329921,
          "apiCalls": 40,
          "snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
          "endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
          "connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
        }
      ],
      "network": {
        "rxBytes": 0,
        "txBytes": 0
      },
      "totalApiCalls": 0
    },
    "stopTime": "2021-12-23T12:28:21.000000Z",
    "createdAt": "2021-12-23T12:28:21.000000Z",
    "isTestRun": true,
    "startTime": "2021-12-23T12:28:21.000000Z",
    "updatedAt": "2021-12-23T12:28:21.000000Z",
    "isArchived": true,
    "expectedInputs": {},
    "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
  },
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "runMode": "triggered",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "lastRunAt": "2021-12-23T12:28:21.000000Z",
  "schedules": [
    {
      "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
      "stopAt": "2022-12-01 00:00:00",
      "startAt": "2021-12-01 00:00:00",
      "interval": 30,
      "timezone": "Europe/Stockholm",
      "lastStartedAt": "2022-01-01T12:28:21.000000Z"
    }
  ],
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "workspace": {},
  "snippetIds": [
    "e0e720d0-4947-11ec-a1d2-9559fa35801d"
  ],
  "description": "string",
  "endpointIds": [
    "9d94bef0-b28c-11eb-8dba-01593c457362",
    "53a6fb70-b28f-11eb-b601-b545a40867e0"
  ],
  "connectorIds": [
    "0d87808f-27c0-11ea-921c-022e6b5ea1e2",
    "0d86ee8a-27c0-11ea-921c-022e6b5ea1e2"
  ],
  "lastRunStatus": "finished",
  "executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1"
}

Updates the full definition of an automation. The requesting user must be the owner of the automation.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	managebuild

Path Parameters

idstring
Required

The unique identifier for the automation.

Request Body

Required

application/json

Automation object to update

application/jsonobject
Show application/json properties
- namestring
- statestring
  
  Can be one of: "available""unavailable""disabled"
  
  default = "available"
- schedulesarray of objects
  
  Show schedules properties
  
  stopAtstring
  
  startAtstring
  
  intervalinteger
  
  time in seconds.
  
  timezonestring
- workspaceobject
  
  The workspace generated by the Qlik Application Automations editor.
- descriptionstring

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  format = "uuid"
- namestring
- statestring
  
  Can be one of: "available""unavailable""disabled"
  
  default = "available"
- lastRunobject
  
  Show lastRun properties
  
  idstring
  
  format = "uuid"
  
  errorobject
  
  titlestring
  
  inputsobject
  Experimental
  
  statusstring
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped"
  
  contextstring
  
  The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
  
  metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
  
  stopTimestring
  
  format = "date-time"
  
  createdAtstring
  
  format = "date-time"
  
  isTestRunboolean
  
  startTimestring
  
  format = "date-time"
  
  updatedAtstring
  
  format = "date-time"
  
  isArchivedboolean
  
  expectedInputsobject
  Experimental
  
  scheduledStartTimestring
  
  format = "date-time"
- ownerIdstring
- runModestring
  
  Can be one of: "manual""scheduled""triggered""webhook"
- createdAtstring
  
  format = "date-time"
- lastRunAtstring
  
  format = "date-time"
- schedulesarray of objects
  
  Show schedules properties
  
  idstring
  
  format = "uuid"
  
  stopAtstring
  
  startAtstring
  
  intervalinteger
  
  time in seconds.
  
  timezonestring
  
  lastStartedAtstring
  
  format = "date-time"
- updatedAtstring
  
  format = "date-time"
- workspaceobject
  
  The workspace generated by the Qlik Application Automations editor.
- snippetIdsarray of strings
  
  A list of snippets that were detected inside the workspace. This includes snippet blocks that are not connected to other blocks. Order of guids is not guaranteed.
- descriptionstring
- endpointIdsarray of strings
  
  A list of endpoints that were detected inside the workspace. This includes Endpoints present in blocks which are not connected to other blocks. Order of guids is not guaranteed.
- connectorIdsarray of strings
  
  A list of connectors that were detected the workspace. This includes Connectors present in blocks which are not connected to other blocks. Order of guids is not guaranteed.
- lastRunStatusstring
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped"
- executionTokenstring

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

PUT /v1/automations/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string","state":"available","schedules":[{"stopAt":"2022-12-01 00:00:00","startAt":"2022-01-01 00:00:00","interval":30,"timezone":"Europe/Stockholm"}],"workspace":{},"description":"string"}'

const https = require('https')
  const data = JSON.stringify({"name":"string","state":"available","schedules":[{"stopAt":"2022-12-01 00:00:00","startAt":"2022-01-01 00:00:00","interval":30,"timezone":"Europe/Stockholm"}],"workspace":{},"description":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik automation update <automationId> \
--description="string" \
--name="string" \
--schedules='{"stopAt":"2022-12-01 00:00:00","startAt":"2022-01-01 00:00:00","interval":30,"timezone":"Europe/Stockholm"}' \
--state="available"

Request

{
  "name": "string",
  "state": "available",
  "schedules": [
    {
      "stopAt": "2022-12-01 00:00:00",
      "startAt": "2022-01-01 00:00:00",
      "interval": 30,
      "timezone": "Europe/Stockholm"
    }
  ],
  "workspace": {},
  "description": "string"
}

Response

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "name": "string",
  "state": "available",
  "lastRun": {
    "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
    "error": {},
    "title": "string",
    "inputs": {},
    "status": "failed",
    "context": "test_run",
    "metrics": {
      "blocks": [
        {
          "type": "endpointBlock",
          "rxBytes": 18329921,
          "txBytes": 18329921,
          "apiCalls": 40,
          "snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
          "endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
          "connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
        }
      ],
      "network": {
        "rxBytes": 0,
        "txBytes": 0
      },
      "totalApiCalls": 0
    },
    "stopTime": "2021-12-23T12:28:21.000000Z",
    "createdAt": "2021-12-23T12:28:21.000000Z",
    "isTestRun": true,
    "startTime": "2021-12-23T12:28:21.000000Z",
    "updatedAt": "2021-12-23T12:28:21.000000Z",
    "isArchived": true,
    "expectedInputs": {},
    "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
  },
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "runMode": "triggered",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "lastRunAt": "2021-12-23T12:28:21.000000Z",
  "schedules": [
    {
      "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
      "stopAt": "2022-12-01 00:00:00",
      "startAt": "2021-12-01 00:00:00",
      "interval": 30,
      "timezone": "Europe/Stockholm",
      "lastStartedAt": "2022-01-01T12:28:21.000000Z"
    }
  ],
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "workspace": {},
  "snippetIds": [
    "e0e720d0-4947-11ec-a1d2-9559fa35801d"
  ],
  "description": "string",
  "endpointIds": [
    "9d94bef0-b28c-11eb-8dba-01593c457362",
    "53a6fb70-b28f-11eb-b601-b545a40867e0"
  ],
  "connectorIds": [
    "0d87808f-27c0-11ea-921c-022e6b5ea1e2",
    "0d86ee8a-27c0-11ea-921c-022e6b5ea1e2"
  ],
  "lastRunStatus": "finished",
  "executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1"
}

Deletes an automation. The requesting user must be the owner of the automation, or be assigned the TenantAdmin role.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	managebuild

Path Parameters

idstring
Required

The unique identifier for the automation.

Responses

204

No Content

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

DELETE /v1/automations/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik automation rm <automationId>

Duplicates an existing automation. The requesting user must be the owner of the automation.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	managebuild

Path Parameters

idstring
Required

The unique identifier for the automation.

Request Body

Required

application/json

application/jsonobject
Show application/json properties
- namestring
  Required
  
  Name of the new automation.

Responses

201

application/json

Created

application/jsonobject
Show application/json properties
- idstring
  
  The unique identifier for the automation.
  
  format = "uuid"

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /v1/automations/{id}/actions/copy

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/actions/copy" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string"}'

const https = require('https')
  const data = JSON.stringify({"name":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}/actions/copy',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik automation copy <automationId> \
--name="string"

Request

{
  "name": "string"
}

Response

{
  "id": "00000000-0000-0000-0000-000000000000"
}

Disables an automation so that it cannot be run. The requesting user must be the owner of the automation, or be assigned the TenantAdmin role.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	managebuild

Path Parameters

idstring
Required

The unique identifier for the automation.

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /v1/automations/{id}/actions/disable

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/actions/disable" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}/actions/disable',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik automation disable <automationId>

Enables an automation so that it can be run. The requesting user must be the owner of the automation, or be assigned the TenantAdmin role.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	managebuild

Path Parameters

idstring
Required

The unique identifier for the automation.

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /v1/automations/{id}/actions/enable

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/actions/enable" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}/actions/enable',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik automation enable <automationId>

Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	managebuild

Path Parameters

idstring
Required

The unique identifier for the automation.

format = "uuid"

Request Body

Required

application/json

application/jsonobject
Show application/json properties
- userIdstring
  Required

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /v1/automations/{id}/actions/move

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/actions/move" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"userId":"sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"}'

const https = require('https')
  const data = JSON.stringify({"userId":"sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}/actions/move',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik automation move <automationId> \
--userId="sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"

Request

{
  "userId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"
}

Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the TenantAdmin role.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	managebuild

Query Parameters

fieldsstring

Allows to select the actual fields to be returned. Where the default is all fields

default = ""
filterstring

Allowed filters: status, context, startTime and title
limitinteger

The number of runs to retrieve.

minimum = 1, maximum = 200, default = 10, default = 10
sortstring

The field to sort by, with +- prefix indicating sort order. (?query=-startTime => sort on the startTime field using descending order)

Can be one of: "id""status""startTime""-id""-status""-startTime""+id""+status""+startTime"

default = "id"

Path Parameters

idstring
Required

The unique identifier for the automation.

format = "uuid"

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  
  format = "uuid"
  
  errorobject
  
  titlestring
  
  statusstring
  Filterable
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped"
  
  contextstring
  Filterable
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
  
  durationinteger
  Filterable
  
  Duration of the run, indicated in seconds. Calculated from start and stop times
  
  stopTimestring
  
  format = "date-time"
  
  createdAtstring
  
  isTestRunboolean
  
  startTimestring
  
  format = "date-time"
  
  updatedAtstring
  
  isArchivedboolean
  
  scheduledStartTimestring
  
  format = "date-time"
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  The URL to a resource request
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  The URL to a resource request

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /v1/automations/{id}/runs

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/runs" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}/runs',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik automation run ls

Response

{
  "data": [
    {
      "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
      "error": {},
      "title": "string",
      "status": "failed",
      "context": "test_run",
      "duration": "9001",
      "stopTime": "2021-12-23T12:28:21.000000Z",
      "createdAt": "2021-12-23T12:28:21.000000Z",
      "isTestRun": true,
      "startTime": "2021-12-23T12:28:21.000000Z",
      "updatedAt": "2021-12-23T12:28:21.000000Z",
      "isArchived": true,
      "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}

Creates a runs for a specific automation. The requesting user must be the owner of the automation.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	managebuild

Path Parameters

idstring
Required

The unique identifier for the automation.

Request Body

Required

application/json

Run object to create

application/jsonobject
Show application/json properties
- inputsobject
  Experimental
- contextstring
  Required
  
  The source that triggers the automation will set the context.
  
  Can be one of: "api"

Responses

201

application/json

Created

application/jsonobject
Show application/json properties
- idstring
  
  format = "uuid"
- errorobject
- titlestring
- inputsobject
  Experimental
- statusstring
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped"
- contextstring
  
  The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
- metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
- stopTimestring
  
  format = "date-time"
- createdAtstring
  
  format = "date-time"
- isTestRunboolean
- startTimestring
  
  format = "date-time"
- updatedAtstring
  
  format = "date-time"
- isArchivedboolean
- expectedInputsobject
  Experimental
- scheduledStartTimestring
  
  format = "date-time"

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /v1/automations/{id}/runs

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/runs" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"inputs":{},"context":"api"}'

const https = require('https')
  const data = JSON.stringify({"inputs":{},"context":"api"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}/runs',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik automation run create

Request

{
  "inputs": {},
  "context": "api"
}

Response

{
  "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
  "error": {},
  "title": "string",
  "inputs": {},
  "status": "failed",
  "context": "test_run",
  "metrics": {
    "blocks": [
      {
        "type": "endpointBlock",
        "rxBytes": 18329921,
        "txBytes": 18329921,
        "apiCalls": 40,
        "snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
      }
    ],
    "network": {
      "rxBytes": 0,
      "txBytes": 0
    },
    "totalApiCalls": 0
  },
  "stopTime": "2021-12-23T12:28:21.000000Z",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "isTestRun": true,
  "startTime": "2021-12-23T12:28:21.000000Z",
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "isArchived": true,
  "expectedInputs": {},
  "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
}

Retrieves a specific run for an automation. The requesting user must be the owner of the automation.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	managebuild

Query Parameters

fieldsstring

Allows to select the actual fields to be returned. Where the default is all fields

default = ""

Path Parameters

idstring
Required

The unique identifier for the automation.
runIdstring
Required

The unique identifier for the run.

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  format = "uuid"
- errorobject
- titlestring
- inputsobject
  Experimental
- statusstring
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped"
- contextstring
  
  The source that triggers the automation will set the context. Certain contexts impact the execution of an automation (for example, The "test_run" context will not process all results when listing items).
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
- metricsobject
  
  Show metrics properties
  
  blocksarray of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  typestring
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytesinteger
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytesinteger
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCallsinteger
  
  API calls to external resources made by the current block.
  
  snippetIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointIdstring
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  connectorIdstring
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  networkobject
  
  Show network properties
  
  rxBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytesinteger
  
  The number of received bytes.
  
  default = 0, default = 0
  
  totalApiCallsinteger
  
  The number of API calls made.
  
  default = 0, default = 0
- stopTimestring
  
  format = "date-time"
- createdAtstring
  
  format = "date-time"
- isTestRunboolean
- startTimestring
  
  format = "date-time"
- updatedAtstring
  
  format = "date-time"
- isArchivedboolean
- expectedInputsobject
  Experimental
- scheduledStartTimestring
  
  format = "date-time"

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /v1/automations/{id}/runs/{runId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/runs/{runId}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}/runs/{runId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik automation run get <runId>

Response

{
  "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
  "error": {},
  "title": "string",
  "inputs": {},
  "status": "failed",
  "context": "test_run",
  "metrics": {
    "blocks": [
      {
        "type": "endpointBlock",
        "rxBytes": 18329921,
        "txBytes": 18329921,
        "apiCalls": 40,
        "snippetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "endpointId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "connectorId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4"
      }
    ],
    "network": {
      "rxBytes": 0,
      "txBytes": 0
    },
    "totalApiCalls": 0
  },
  "stopTime": "2021-12-23T12:28:21.000000Z",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "isTestRun": true,
  "startTime": "2021-12-23T12:28:21.000000Z",
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "isArchived": true,
  "expectedInputs": {},
  "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
}

Retrieves the URL for the debug log of a specific automation run. The requesting user must be the owner of the automation.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	managebuild

Path Parameters

idstring
Required

The unique identifier for the automation.
runIdstring
Required

The unique identifier for the run.

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- urlstring

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /v1/automations/{id}/runs/{runId}/actions/export

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/runs/{runId}/actions/export" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}/runs/{runId}/actions/export',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik automation run action export create \
--runId="string"

Response

{
  "url": "https://{tenantname}.{region}.qlikcloud.com/api/v1/automations/{id}/runs/{runId}/debug"
}

Retries a specific run by creating a new run using the same inputs. The requesting user must be the owner of the automation.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	managebuild

Path Parameters

idstring
Required

The unique identifier for the automation.
runIdstring
Required

The unique identifier for the run.

Responses

204

OK Response

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /v1/automations/{id}/runs/{runId}/actions/retry

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/runs/{runId}/actions/retry" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}/runs/{runId}/actions/retry',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik automation run retry \
--runId="string"

Forcefully stops an automation run immediately. The requesting user must be the owner of the automation.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	managebuild

Path Parameters

idstring
Required

The unique identifier for the automation.
runIdstring
Required

The unique identifier for the run.

Responses

204

OK Response

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

404

application/json

Not found

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

POST /v1/automations/{id}/runs/{runId}/actions/stop

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/runs/{runId}/actions/stop" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/{id}/runs/{runId}/actions/stop',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik automation run stop \
--runId="string"

Retrieves paginated usage metrics for automations. The requesting user must be assigned the TenantAdmin role.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	managebuild

Query Parameters

filterstring
Required

Indicates how the metrics should be filtered
breakdownBystring

If specified, result will be broken apart for each automation

Responses

200

application/json

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  datestring
  Required
  
  The date for the metric
  
  namestring
  Required
  
  The name for the metric
  
  Can be one of: "runs""scheduledRun""triggeredRun""webhookRuns""duration""bandwidthIn""bandwidthOut"
  
  maxLength = 50
  
  valueinteger
  Required
  
  The value count of the metric
  
  automationobject
  
  Show automation properties
  
  guidstring
  Filterable
  
  The unique identifier for the automation.
  
  namestring
  
  The name for the automation.
  
  maxLength = 50
  
  ownerIdstring
  Filterable
  
  The unique identifier for the user who owns the automation
  
  durationinteger
  Filterable
  
  Duration of the last run, indicated in seconds. Calculated from start and stop times
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  The URL to a resource request
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  The URL to a resource request

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

500

application/json

Internal Server Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The unique code for the error
  
  titlestring
  Required
  
  A summary of what went wrong
  
  detailstring
  
  May be used to provide additional details
- traceIdstring
  
  A way to trace the source of the error.

GET /v1/automations/usage

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/usage" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automations/usage',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

qlik automation usage ls

Response

{
  "data": [
    {
      "date": "2021-12-15",
      "name": "bandwidthIn",
      "value": 310179713,
      "automation": {
        "guid": "00000000-0000-0000-0000-000000000000",
        "name": "My Automation.",
        "ownerId": "KP1zJiPDn0gsla236GmETadFcxBW-J8F",
        "duration": 9001
      }
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}

Automations

Endpoints

List automations

Facts

Query Parameters

Responses

200

400

401

403

500

503

Response

Create an automation

Facts

Request Body

Responses

201

400

401

403

500

503

Request

Response

Get an automation

Facts

Query Parameters

Path Parameters

Responses

200

400

401

403

404

500

503

Response

Update an automation

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

500

503

Request

Response

Delete an automation

Facts

Path Parameters

Responses

204

401

403

404

500

503

Duplicate an automation

Facts

Path Parameters

Request Body

Responses

201

400

401

403

404

500

503

Request

Response

Disable an automation

Facts

Path Parameters

Responses