Automations

Download OpenAPI spec

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

Use the namespaced API

Use the Automations API in the Workflows namespace for all new implementations.

This API remains available and fully supported, but the Workflows namespace is the preferred approach moving forward.

Consider using the namespaced API for new implementations.

Endpoints

GET

/api/v1/automations
POST

/api/v1/automations
GET

/api/v1/automations/{id}
PUT

/api/v1/automations/{id}
DELETE

/api/v1/automations/{id}
POST

/api/v1/automations/{id}/actions/change-owner
POST

/api/v1/automations/{id}/actions/change-space
POST

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

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

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

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

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

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

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

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

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

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

/api/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)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	GET workflows/automations

Query Parameters

cursor string

Pagination cursor returned from a previous request.
filter string

Allowed filters: name, runMode, lastRunStatus, ownerId, spaceId.
limit integer

The number of automations to retrieve.

minimum = 1, maximum = 200, default = 100, default = 100
listAll boolean

When true, list all automations. Restricted to tenant admins and analytics admins.

default = true
sort string

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

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

Responses

200

OK Response

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  The unique identifier for the automation.
  
  format = "uuid"
  
  name string
  
  Filterable
  
  The name of the automation.
  
  state string
  
  The state of the automation.
  
  Can be one of: "available""unavailable""disabled"
  default = "available"
  
  lastRun object
  
  Show lastRun properties
  
  id string
  
  The unique identifier of the run.
  
  format = "uuid"
  
  error array of objects
  
  List of errors that occurred during the automation run.
  
  title string
  
  The title of the automation run.
  
  status string
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
  
  context string
  
  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"
  
  metrics object
  
  Show metrics properties
  
  blocks array of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  type string
  
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytes integer
  
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytes integer
  
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCalls integer
  
  API calls to external resources made by the current block.
  
  snippetId string
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointId string
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorId string
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  network object
  
  Show network properties
  
  rxBytes integer
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytes integer
  
  The number of sent bytes.
  
  default = 0, default = 0
  
  totalApiCalls integer
  
  The number of API calls made.
  
  default = 0, default = 0
  
  ownerId string
  
  The unique identifier of the owner of the automation run.
  
  spaceId string
  
  The unique identifier of the space in which the automation run is created.
  
  testRun boolean
  
  Indicates if this automation run is a test run.
  
  archived boolean
  
  Indicates if this automation run is archived.
  
  stopTime string
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
  
  createdAt string
  
  format = "date-time"
  
  isTestRun boolean
  
  Indicates if this automation run is a test run.
  
  startTime string
  
  The date and time at which the automation run started.
  
  format = "date-time"
  
  updatedAt string
  
  format = "date-time"
  
  isArchived boolean
  
  Indicates if this automation run is archived.
  
  executedById string
  
  The unique identifier of the user who executed the automation run.
  
  scheduledStartTime string
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"
  
  ownerId string
  
  Filterable
  
  The unique identifier of the owner of the automation.
  
  runMode string
  
  Filterable
  
  Defines how the automation run is started.
  
  Can be one of: "manual""scheduled""triggered""webhook"
  
  spaceId string
  
  Filterable
  
  The unique identifier of the space that contains the automation.
  
  duration integer
  
  Filterable
  
  Duration of the last run, indicated in seconds. Calculated from start and stop times.
  
  createdAt string
  
  format = "date-time"
  
  lastRunAt string
  
  The date and time when the last automation run was finished.
  
  format = "date-time"
  
  updatedAt string
  
  format = "date-time"
  
  workspace object
  
  The workspace contains the JSON representation of the used blocks
  
  snippetIds array of strings
  
  A list of snippets that were detected in the workspace. This includes snippet blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
  
  description string
  
  The description of the automation.
  
  endpointIds array of strings
  
  A list of endpoints that were detected in the workspace. This includes endpoints present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
  
  connectorIds array of strings
  
  A list of connectors that were detected in the workspace. This includes connectors present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
  
  lastRunStatus string
  
  Filterable
  
  The status of the last run of the automation.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped""exceeded limit"
  
  executionToken string
  
  maxConcurrentRuns integer
  
  Maximum number of concurrent runs allowed for automation.
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  The URL to a resource request
  
  prev object
  
  Show prev properties
  
  href string
  
  The URL to a resource request

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

GET /api/v1/automations

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.getAutomations({})

qlik automation ls

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

Example Response

{
  "data": [
    {
      "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
      "name": "string",
      "state": "available",
      "lastRun": {
        "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
        "error": [
          {}
        ],
        "title": "string",
        "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
        },
        "ownerId": "string",
        "spaceId": "string",
        "testRun": true,
        "archived": true,
        "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,
        "executedById": "string",
        "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
      },
      "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
      "runMode": "triggered",
      "spaceId": "5f0f78b239ff4f0001234567",
      "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",
      "maxConcurrentRuns": 10
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}

Creates a new automation. The requesting user must be assigned the AutomationCreator role or have at least one of the following scopes: automations, admin.automations, automations.private or automations.shared.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST workflows/automations

Request Body

Required

Automation object to create

application/json object
Show application/json properties
- name string
- spaceId string
- schedules array of objects
  
  Show schedules properties
  
  stopAt string
  
  The date and time until the schedule is active. If omitted or null, any existing end date is removed.
  
  startAt string
  
  The date and time when the schedule becomes active. If null, any existing start date is removed and the schedule is active from now. If omitted, an existing start date that is still in the future is removed; one that is already in the past is kept.
  
  interval integer Deprecated
  
  Interval in seconds; must be a multiple of 60. Values are rounded to the nearest minute (≥30 seconds rounded up, otherwise down).
  
  timezone string
  
  recurrence string
  
  The RRULE that defines when the automation runs. When provided, it takes precedence over interval.
- workspace object
  
  The workspace generated by the Qlik Automate editor.
- description string
- maxConcurrentRuns integer
  
  Maximum number of concurrent runs allowed for this automation. The maximum value is defined in automations settings.
  
  minimum = 1, default = 1, default = 1

Responses

201

Created

application/json object
Show application/json properties
- id string
  
  format = "uuid"
- name string
  
  The name of the automation.
- state string
  
  The state of the automation.
  
  Can be one of: "available""unavailable""disabled"
  default = "available"
- lastRun object
  
  Show lastRun properties
  
  id string
  
  The unique identifier of the run.
  
  format = "uuid"
  
  error array of objects
  
  List of errors that occurred during the automation run.
  
  title string
  
  The title of the automation run.
  
  status string
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
  
  context string
  
  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"
  
  metrics object
  
  Show metrics properties
  
  blocks array of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  type string
  
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytes integer
  
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytes integer
  
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCalls integer
  
  API calls to external resources made by the current block.
  
  snippetId string
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointId string
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorId string
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  network object
  
  Show network properties
  
  rxBytes integer
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytes integer
  
  The number of sent bytes.
  
  default = 0, default = 0
  
  totalApiCalls integer
  
  The number of API calls made.
  
  default = 0, default = 0
  
  ownerId string
  
  The unique identifier of the owner of the automation run.
  
  spaceId string
  
  The unique identifier of the space in which the automation run is created.
  
  testRun boolean
  
  Indicates if this automation run is a test run.
  
  archived boolean
  
  Indicates if this automation run is archived.
  
  stopTime string
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
  
  createdAt string
  
  format = "date-time"
  
  isTestRun boolean
  
  Indicates if this automation run is a test run.
  
  startTime string
  
  The date and time at which the automation run started.
  
  format = "date-time"
  
  updatedAt string
  
  format = "date-time"
  
  isArchived boolean
  
  Indicates if this automation run is archived.
  
  executedById string
  
  The unique identifier of the user who executed the automation run.
  
  scheduledStartTime string
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"
- ownerId string
  
  The unique identifier of the owner of the automation.
- runMode string
  
  Defines how the automation run is started.
  
  Can be one of: "manual""scheduled""triggered""webhook"
- spaceId string
  
  The unique identifier of the space that contains the automation.
- createdAt string
  
  format = "date-time"
- lastRunAt string
  
  The date and time when the last automation run was finished.
  
  format = "date-time"
- schedules array of objects
  
  Show schedules properties
  
  id string
  
  format = "uuid"
  
  stopAt string
  
  startAt string
  
  interval integer Deprecated
  
  Interval in seconds.
  
  timezone string
  
  nextRunAt string
  
  recurrence string
  
  The RRULE that defines when the automation runs.
  
  lastStartedAt string
  
  format = "date-time"
- updatedAt string
  
  format = "date-time"
- workspace object
  
  The workspace generated by the Qlik Automate editor.
- snippetIds array of strings
  
  A list of snippets that were detected in the workspace. This includes snippet blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
- description string
  
  The description of the automation.
- endpointIds array of strings
  
  A list of endpoints that were detected in the workspace. This includes endpoints present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
- connectorIds array of strings
  
  A list of connectors that were detected in the workspace. This includes connectors present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
- lastRunStatus string
  
  The status of the last run of the automation.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped""exceeded limit"
- executionToken string
  
  Execution token required to authorize the execution of the automation.
- maxConcurrentRuns integer
  
  Maximum number of concurrent runs allowed for this automation.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

POST /api/v1/automations

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.createAutomation({
  description: 'string',
  maxConcurrentRuns: 1,
  name: 'string',
  schedules: [
    {
      interval: 60,
      recurrence:
        'RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=9;BYMINUTE=0;BYSECOND=0',
      startAt: '2022-01-01 00:00:00',
      stopAt: '2022-12-01 00:00:00',
      timezone: 'Europe/Stockholm',
    },
  ],
  spaceId: 'string',
  workspace: {},
})

qlik automation create

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/automations" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string","spaceId":"string","schedules":[{"stopAt":"2022-12-01 00:00:00","startAt":"2022-01-01 00:00:00","interval":60,"timezone":"Europe/Stockholm","recurrence":"RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=9;BYMINUTE=0;BYSECOND=0"}],"workspace":{},"description":"string","maxConcurrentRuns":1}'

Example Response

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "name": "string",
  "state": "available",
  "lastRun": {
    "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
    "error": [
      {}
    ],
    "title": "string",
    "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
    },
    "ownerId": "string",
    "spaceId": "string",
    "testRun": true,
    "archived": true,
    "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,
    "executedById": "string",
    "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
  },
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "runMode": "triggered",
  "spaceId": "5f0f78b239ff4f0001234567",
  "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": 60,
      "timezone": "Europe/Stockholm",
      "nextRunAt": "2021-12-01 00:00:00",
      "recurrence": "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=9;BYMINUTE=0;BYSECOND=0",
      "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",
  "maxConcurrentRuns": 10
}

Retrieves the full definition of an automation. The requesting user must be the owner of the automation and either be assigned one of the roles: AutomationsCreator, TenantAdmin or have at least one of the following scopes (depending on whether the automation is in a private or shared space): automations, automations.private or automations.shared.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	GET workflows/automations/{id}

Path Parameters

id string

Required

The unique identifier for the automation.

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  format = "uuid"
- name string
  
  The name of the automation.
- state string
  
  The state of the automation.
  
  Can be one of: "available""unavailable""disabled"
  default = "available"
- lastRun object
  
  Show lastRun properties
  
  id string
  
  The unique identifier of the run.
  
  format = "uuid"
  
  error array of objects
  
  List of errors that occurred during the automation run.
  
  title string
  
  The title of the automation run.
  
  status string
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
  
  context string
  
  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"
  
  metrics object
  
  Show metrics properties
  
  blocks array of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  type string
  
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytes integer
  
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytes integer
  
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCalls integer
  
  API calls to external resources made by the current block.
  
  snippetId string
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointId string
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorId string
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  network object
  
  Show network properties
  
  rxBytes integer
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytes integer
  
  The number of sent bytes.
  
  default = 0, default = 0
  
  totalApiCalls integer
  
  The number of API calls made.
  
  default = 0, default = 0
  
  ownerId string
  
  The unique identifier of the owner of the automation run.
  
  spaceId string
  
  The unique identifier of the space in which the automation run is created.
  
  testRun boolean
  
  Indicates if this automation run is a test run.
  
  archived boolean
  
  Indicates if this automation run is archived.
  
  stopTime string
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
  
  createdAt string
  
  format = "date-time"
  
  isTestRun boolean
  
  Indicates if this automation run is a test run.
  
  startTime string
  
  The date and time at which the automation run started.
  
  format = "date-time"
  
  updatedAt string
  
  format = "date-time"
  
  isArchived boolean
  
  Indicates if this automation run is archived.
  
  executedById string
  
  The unique identifier of the user who executed the automation run.
  
  scheduledStartTime string
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"
- ownerId string
  
  The unique identifier of the owner of the automation.
- runMode string
  
  Defines how the automation run is started.
  
  Can be one of: "manual""scheduled""triggered""webhook"
- spaceId string
  
  The unique identifier of the space that contains the automation.
- createdAt string
  
  format = "date-time"
- lastRunAt string
  
  The date and time when the last automation run was finished.
  
  format = "date-time"
- schedules array of objects
  
  Show schedules properties
  
  id string
  
  format = "uuid"
  
  stopAt string
  
  startAt string
  
  interval integer Deprecated
  
  Interval in seconds.
  
  timezone string
  
  nextRunAt string
  
  recurrence string
  
  The RRULE that defines when the automation runs.
  
  lastStartedAt string
  
  format = "date-time"
- updatedAt string
  
  format = "date-time"
- workspace object
  
  The workspace generated by the Qlik Automate editor.
- snippetIds array of strings
  
  A list of snippets that were detected in the workspace. This includes snippet blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
- description string
  
  The description of the automation.
- endpointIds array of strings
  
  A list of endpoints that were detected in the workspace. This includes endpoints present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
- connectorIds array of strings
  
  A list of connectors that were detected in the workspace. This includes connectors present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
- lastRunStatus string
  
  The status of the last run of the automation.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped""exceeded limit"
- executionToken string
  
  Execution token required to authorize the execution of the automation.
- maxConcurrentRuns integer
  
  Maximum number of concurrent runs allowed for this automation.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

GET /api/v1/automations/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.getAutomation(
  '00000000-0000-0000-0000-000000000000',
)

qlik automation get '00000000-0000-0000-0000-000000000000'

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

Example Response

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "name": "string",
  "state": "available",
  "lastRun": {
    "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
    "error": [
      {}
    ],
    "title": "string",
    "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
    },
    "ownerId": "string",
    "spaceId": "string",
    "testRun": true,
    "archived": true,
    "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,
    "executedById": "string",
    "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
  },
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "runMode": "triggered",
  "spaceId": "5f0f78b239ff4f0001234567",
  "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": 60,
      "timezone": "Europe/Stockholm",
      "nextRunAt": "2021-12-01 00:00:00",
      "recurrence": "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=9;BYMINUTE=0;BYSECOND=0",
      "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",
  "maxConcurrentRuns": 10
}

Updates the full definition of an automation. The requesting user must be the owner of the automation and either be assigned the AutomationCreator role or have at least one of the following scopes: automations, admin.automations, automations.private or automations.shared.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	PUT workflows/automations/{id}

Path Parameters

id string

Required

The unique identifier for the automation.

Request Body

Required

Automation object to update

application/json object
Show application/json properties
- name string
- schedules array of objects
  
  Show schedules properties
  
  stopAt string
  
  The date and time until the schedule is active. If omitted or null, any existing end date is removed.
  
  startAt string
  
  The date and time when the schedule becomes active. If null, any existing start date is removed and the schedule is active from now. If omitted, an existing start date that is still in the future is removed; one that is already in the past is kept.
  
  interval integer Deprecated
  
  Interval in seconds; must be a multiple of 60. Values are rounded to the nearest minute (≥30 seconds rounded up, otherwise down).
  
  timezone string
  
  recurrence string
  
  The RRULE that defines when the automation runs. When provided, it takes precedence over interval.
- workspace object
  
  The workspace generated by the Qlik Automate editor.
- description string
- maxConcurrentRuns integer
  
  Maximum number of concurrent runs allowed for this automation. The maximum value is defined in automations settings.
  
  minimum = 1, default = 1, default = 1

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  format = "uuid"
- name string
  
  The name of the automation.
- state string
  
  The state of the automation.
  
  Can be one of: "available""unavailable""disabled"
  default = "available"
- lastRun object
  
  Show lastRun properties
  
  id string
  
  The unique identifier of the run.
  
  format = "uuid"
  
  error array of objects
  
  List of errors that occurred during the automation run.
  
  title string
  
  The title of the automation run.
  
  status string
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
  
  context string
  
  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"
  
  metrics object
  
  Show metrics properties
  
  blocks array of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  type string
  
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytes integer
  
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytes integer
  
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCalls integer
  
  API calls to external resources made by the current block.
  
  snippetId string
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointId string
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorId string
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  network object
  
  Show network properties
  
  rxBytes integer
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytes integer
  
  The number of sent bytes.
  
  default = 0, default = 0
  
  totalApiCalls integer
  
  The number of API calls made.
  
  default = 0, default = 0
  
  ownerId string
  
  The unique identifier of the owner of the automation run.
  
  spaceId string
  
  The unique identifier of the space in which the automation run is created.
  
  testRun boolean
  
  Indicates if this automation run is a test run.
  
  archived boolean
  
  Indicates if this automation run is archived.
  
  stopTime string
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
  
  createdAt string
  
  format = "date-time"
  
  isTestRun boolean
  
  Indicates if this automation run is a test run.
  
  startTime string
  
  The date and time at which the automation run started.
  
  format = "date-time"
  
  updatedAt string
  
  format = "date-time"
  
  isArchived boolean
  
  Indicates if this automation run is archived.
  
  executedById string
  
  The unique identifier of the user who executed the automation run.
  
  scheduledStartTime string
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"
- ownerId string
  
  The unique identifier of the owner of the automation.
- runMode string
  
  Defines how the automation run is started.
  
  Can be one of: "manual""scheduled""triggered""webhook"
- spaceId string
  
  The unique identifier of the space that contains the automation.
- createdAt string
  
  format = "date-time"
- lastRunAt string
  
  The date and time when the last automation run was finished.
  
  format = "date-time"
- schedules array of objects
  
  Show schedules properties
  
  id string
  
  format = "uuid"
  
  stopAt string
  
  startAt string
  
  interval integer Deprecated
  
  Interval in seconds.
  
  timezone string
  
  nextRunAt string
  
  recurrence string
  
  The RRULE that defines when the automation runs.
  
  lastStartedAt string
  
  format = "date-time"
- updatedAt string
  
  format = "date-time"
- workspace object
  
  The workspace generated by the Qlik Automate editor.
- snippetIds array of strings
  
  A list of snippets that were detected in the workspace. This includes snippet blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
- description string
  
  The description of the automation.
- endpointIds array of strings
  
  A list of endpoints that were detected in the workspace. This includes endpoints present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
- connectorIds array of strings
  
  A list of connectors that were detected in the workspace. This includes connectors present in blocks that are not connected to other blocks. Order of GUIDs is not guaranteed.
- lastRunStatus string
  
  The status of the last run of the automation.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""paused""running""starting""stopped""exceeded limit"
- executionToken string
  
  Execution token required to authorize the execution of the automation.
- maxConcurrentRuns integer
  
  Maximum number of concurrent runs allowed for this automation.

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

PUT /api/v1/automations/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.updateAutomation(
  '00000000-0000-0000-0000-000000000000',
  {
    description: 'string',
    maxConcurrentRuns: 1,
    name: 'string',
    schedules: [
      {
        interval: 60,
        recurrence:
          'RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=9;BYMINUTE=0;BYSECOND=0',
        startAt: '2022-01-01 00:00:00',
        stopAt: '2022-12-01 00:00:00',
        timezone: 'Europe/Stockholm',
      },
    ],
    workspace: {},
  },
)

qlik automation update '00000000-0000-0000-0000-000000000000'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/automations/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string","schedules":[{"stopAt":"2022-12-01 00:00:00","startAt":"2022-01-01 00:00:00","interval":60,"timezone":"Europe/Stockholm","recurrence":"RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=9;BYMINUTE=0;BYSECOND=0"}],"workspace":{},"description":"string","maxConcurrentRuns":1}'

Example Response

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "name": "string",
  "state": "available",
  "lastRun": {
    "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
    "error": [
      {}
    ],
    "title": "string",
    "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
    },
    "ownerId": "string",
    "spaceId": "string",
    "testRun": true,
    "archived": true,
    "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,
    "executedById": "string",
    "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
  },
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "runMode": "triggered",
  "spaceId": "5f0f78b239ff4f0001234567",
  "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": 60,
      "timezone": "Europe/Stockholm",
      "nextRunAt": "2021-12-01 00:00:00",
      "recurrence": "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=9;BYMINUTE=0;BYSECOND=0",
      "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",
  "maxConcurrentRuns": 10
}

Deletes an automation. The requesting user must meet at least one of the following conditions:

be the owner of the automation
be assigned one of the following roles: AnalyticsAdmin, TenantAdmin
have at least one of the following scopes: admin.automations, admin.automations:strict, automations.private, or automations.shared

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	DELETE workflows/automations/{id}

Path Parameters

id string

Required

The unique identifier for the automation.

Responses

204

No Content

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

DELETE /api/v1/automations/{id}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.deleteAutomation(
  '00000000-0000-0000-0000-000000000000',
)

qlik automation rm '00000000-0000-0000-0000-000000000000'

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

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. The requesting user must be assigned TenantAdmin role or have at least one of the following scopes: admin.automations, admin.automations:strict.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST workflows/automations/{id}/actions/change-owner

Path Parameters

id string

Required

The unique identifier for the automation.

format = "uuid"

Request Body

Required

application/json object
Show application/json properties
- userId string
  
  Required
  
  The unique identifier of the new owner.

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

POST /api/v1/automations/{id}/actions/change-owner

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.changeOwnerAutomation(
  '00000000-0000-0000-0000-000000000000',
  { userId: 'sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy' },
)

qlik automation change-owner '00000000-0000-0000-0000-000000000000' \
  --userId 'sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy'

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

Changes the space of an automation by specifying a new space.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST workflows/automations/{id}/actions/change-space

Path Parameters

id string

Required

The unique identifier for the automation.

Request Body

application/json object
Show application/json properties
- spaceId string
  
  Required
  
  The unique identifier of the new space.

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

POST /api/v1/automations/{id}/actions/change-space

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.changeSpaceAutomation(
  '00000000-0000-0000-0000-000000000000',
  { spaceId: '5f0f78b239ff4f0001234567' },
)

qlik automation change-space '00000000-0000-0000-0000-000000000000' \
  --spaceId '5f0f78b239ff4f0001234567'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/automations/{id}/actions/change-space" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"spaceId":"5f0f78b239ff4f0001234567"}'

Duplicates an existing automation.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST workflows/automations/{id}/actions/copy

Path Parameters

id string

Required

The unique identifier for the automation.

Request Body

Required

application/json object
Show application/json properties
- name string
  
  Required
  
  Name of the new automation.

Responses

201

Created

application/json object
Show application/json properties
- id string
  
  The unique identifier for the automation.
  
  format = "uuid"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.copyAutomation(
  '00000000-0000-0000-0000-000000000000',
  { name: 'string' },
)

qlik automation copy '00000000-0000-0000-0000-000000000000' \
  --name 'string'

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

Example Response

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

Disables an automation so that it cannot be run. To disable an automation, the requesting user must meet at least one of the following conditions:

be the owner of the automation
be assigned one of the following roles: TenantAdmin, AnalyticsAdmin
have at least one of the following scopes: admin.automations, admin.automations:strict, automations.private, or automations.shared

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST workflows/automations/{id}/actions/disable

Path Parameters

id string

Required

The unique identifier for the automation.

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.disableAutomation(
  '00000000-0000-0000-0000-000000000000',
)

qlik automation disable '00000000-0000-0000-0000-000000000000'

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

Enables an automation so that it can be run. To enable an automation, the requesting user must meet at least one of the following conditions:

be the owner of the automation
be assigned one of the following roles: AnalyticsAdmin, TenantAdmin
have at least one of the following scopes: admin.automations, admin.automations:strict, automations.private, or automations.shared

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST workflows/automations/{id}/actions/enable

Path Parameters

id string

Required

The unique identifier for the automation.

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.enableAutomation(
  '00000000-0000-0000-0000-000000000000',
)

qlik automation enable '00000000-0000-0000-0000-000000000000'

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

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. The requesting user must be assigned TenantAdmin role or have at least one of the following scopes: admin.automations, admin.automations:strict.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST workflows/automations/{id}/actions/move

Path Parameters

id string

Required

The unique identifier for the automation.

format = "uuid"

Request Body

Required

application/json object
Show application/json properties
- userId string
  
  Required

Responses

204

No Content

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.moveAutomation(
  '00000000-0000-0000-0000-000000000000',
  { userId: 'sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy' },
)

qlik automation move '00000000-0000-0000-0000-000000000000' \
  --userId 'sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/automations/{id}/actions/move" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"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 one of roles: TenantAdmin, AnalyticsAdmin. Alternatively, the user must have at least one of the following scopes: admin.automation-runs, automation-runs.private, or automation-runs.shared.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	GET workflows/automations/{id}/runs

Query Parameters

cursor string

Pagination cursor returned from a previous request.
filter string

Allowed filters: status, context, startTime, title, spaceId, ownerId, executedById, billable.
limit integer

The number of runs to retrieve.

minimum = 1, maximum = 200, default = 10, default = 10
sort string

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

id string

Required

The unique identifier for the automation.

format = "uuid"

Responses

200

OK Response

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  id string
  
  format = "uuid"
  
  error array of objects
  
  List of errors that occurred during the automation run.
  
  title string
  
  The title of the automation run.
  
  status string
  
  Filterable
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
  
  context string
  
  Filterable
  
  The context set by the source that triggers the automation.
  
  Can be one of: "test_run""editor""detail""api_sync""api_async""webhook""lookup"
  
  ownerId string
  
  Filterable
  
  The unique identifier of the owner of the automation run.
  
  spaceId string
  
  Filterable
  
  The unique identifier of the space in which the automation run is created.
  
  testRun boolean
  
  Indicates if this automation run is a test run.
  
  archived boolean
  
  Indicates if this automation run is archived.
  
  duration integer
  
  Filterable
  
  Duration of the run, indicated in seconds. Calculated from start and stop times
  
  stopTime string
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
  
  createdAt string
  
  isTestRun boolean
  
  Indicates if this automation run is a test run.
  
  startTime string
  
  The date and time at which the automation run started.
  
  format = "date-time"
  
  updatedAt string
  
  isArchived boolean
  
  Indicates if this automation run is archived.
  
  executedById string
  
  Filterable
  
  The unique identifier of the user who executed the automation run.
  
  scheduledStartTime string
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  The URL to a resource request
  
  prev object
  
  Show prev properties
  
  href string
  
  The URL to a resource request

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.getAutomationRuns(
  '00000000-0000-0000-0000-000000000000',
  {},
)

qlik automation run ls \
  --automationId '00000000-0000-0000-0000-000000000000'

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

Example Response

{
  "data": [
    {
      "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
      "error": [
        {}
      ],
      "title": "string",
      "status": "failed",
      "context": "test_run",
      "ownerId": "string",
      "spaceId": "string",
      "testRun": true,
      "archived": true,
      "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,
      "executedById": "string",
      "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}

Creates a run for a specific automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:

Private space: be the owner of the automation and have the automations.private scope
Shared space: be editor or operator in shared space and have automations.shared scope.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST workflows/automations/{id}/runs

Path Parameters

id string

Required

The unique identifier for the automation.

Request Body

Required

Run object to create

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

Responses

201

Created

application/json object
Show application/json properties
- id string
  
  The unique identifier of the run.
  
  format = "uuid"
- error array of objects
  
  List of errors that occurred during the automation run.
- title string
  
  The title of the automation run.
- status string
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
- context string
  
  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"
- metrics object
  
  Show metrics properties
  
  blocks array of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  type string
  
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytes integer
  
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytes integer
  
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCalls integer
  
  API calls to external resources made by the current block.
  
  snippetId string
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointId string
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorId string
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  network object
  
  Show network properties
  
  rxBytes integer
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytes integer
  
  The number of sent bytes.
  
  default = 0, default = 0
  
  totalApiCalls integer
  
  The number of API calls made.
  
  default = 0, default = 0
- ownerId string
  
  The unique identifier of the owner of the automation run.
- spaceId string
  
  The unique identifier of the space in which the automation run is created.
- testRun boolean
  
  Indicates if this automation run is a test run.
- archived boolean
  
  Indicates if this automation run is archived.
- stopTime string
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
- createdAt string
  
  format = "date-time"
- isTestRun boolean
  
  Indicates if this automation run is a test run.
- startTime string
  
  The date and time at which the automation run started.
  
  format = "date-time"
- updatedAt string
  
  format = "date-time"
- isArchived boolean
  
  Indicates if this automation run is archived.
- executedById string
  
  The unique identifier of the user who executed the automation run.
- scheduledStartTime string
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.queueAutomationRun(
  '00000000-0000-0000-0000-000000000000',
  { context: 'api' },
)

qlik automation run create \
  --automationId '00000000-0000-0000-0000-000000000000' \
  --automation-context 'api'

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

Example Response

{
  "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
  "error": [
    {}
  ],
  "title": "string",
  "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
  },
  "ownerId": "string",
  "spaceId": "string",
  "testRun": true,
  "archived": true,
  "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,
  "executedById": "string",
  "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
}

Retrieves a specific run for an automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:

Private space: be the owner of the automation and have the automations.private scope
Shared space: be editor or operator in shared space and have automations.shared scope.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	GET workflows/automations/{id}/runs/{runId}

Path Parameters

id string

Required

The unique identifier for the automation.
runId string

Required

The unique identifier for the run.

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  The unique identifier of the run.
  
  format = "uuid"
- error array of objects
  
  List of errors that occurred during the automation run.
- title string
  
  The title of the automation run.
- status string
  
  The current status of the automation run.
  
  Can be one of: "failed""finished""finished with warnings""must stop""not started""running""starting""stopped""exceeded limit""queued"
- context string
  
  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"
- metrics object
  
  Show metrics properties
  
  blocks array of objects
  
  List of blocks used during execution. Note: this list currently only contains endpointBlocks and snippetBlocks
  
  Show blocks properties
  
  type string
  
  Required
  
  Type of the block.
  
  Can be one of: "snippetBlock""endpointBlock"
  
  rxBytes integer
  
  Required
  
  Total amount of received bytes sent by the current block.
  
  txBytes integer
  
  Required
  
  Total amount of sent bytes sent by the current block.
  
  apiCalls integer
  
  API calls to external resources made by the current block.
  
  snippetId string
  
  Unique identifier for the snippet block used within the execution.
  
  format = "uuid"
  
  endpointId string
  
  Unique identifier for the endpoint block used within the execution.
  
  format = "uuid"
  
  connectorId string
  
  Unique identifier for the connector used within the block of the execution.
  
  format = "uuid"
  
  network object
  
  Show network properties
  
  rxBytes integer
  
  The number of received bytes.
  
  default = 0, default = 0
  
  txBytes integer
  
  The number of sent bytes.
  
  default = 0, default = 0
  
  totalApiCalls integer
  
  The number of API calls made.
  
  default = 0, default = 0
- ownerId string
  
  The unique identifier of the owner of the automation run.
- spaceId string
  
  The unique identifier of the space in which the automation run is created.
- testRun boolean
  
  Indicates if this automation run is a test run.
- archived boolean
  
  Indicates if this automation run is archived.
- stopTime string
  
  The date and time at which the automation run stopped.
  
  format = "date-time"
- createdAt string
  
  format = "date-time"
- isTestRun boolean
  
  Indicates if this automation run is a test run.
- startTime string
  
  The date and time at which the automation run started.
  
  format = "date-time"
- updatedAt string
  
  format = "date-time"
- isArchived boolean
  
  Indicates if this automation run is archived.
- executedById string
  
  The unique identifier of the user who executed the automation run.
- scheduledStartTime string
  
  The date and time at which the automation run is scheduled to start.
  
  format = "date-time"

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.getAutomationRun(
  '00000000-0000-0000-0000-000000000000',
  '00000000-0000-0000-0000-000000000000',
)

qlik automation run get '00000000-0000-0000-0000-000000000000' \
  --automationId '00000000-0000-0000-0000-000000000000'

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

Example Response

{
  "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
  "error": [
    {}
  ],
  "title": "string",
  "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
  },
  "ownerId": "string",
  "spaceId": "string",
  "testRun": true,
  "archived": true,
  "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,
  "executedById": "string",
  "scheduledStartTime": "2021-12-23T12:28:21.000000Z"
}

Retrieves the URL for the debug log of a specific automation run. Depending on the space the automation belongs to, the requesting user must meet the following requirement:

Private space: be the owner of the automation and have the automations.private scope
Shared space: be editor or operator in shared space and have automations.shared scope.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST workflows/automations/{id}/runs/{runId}/actions/export

Path Parameters

id string

Required

The unique identifier for the automation.
runId string

Required

The unique identifier for the run.

Responses

200

OK Response

application/json object
Show application/json properties
- url string

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.getAutomationRunDetails(
  '00000000-0000-0000-0000-000000000000',
  '00000000-0000-0000-0000-000000000000',
)

qlik automation run export \
  --automationId '00000000-0000-0000-0000-000000000000' \
  --runId '00000000-0000-0000-0000-000000000000'

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

Example 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. Depending on the space the automation belongs to, the requesting user must meet the following requirement:

Private space: be the owner of the automation and have the automations.private scope
Shared space: be editor or operator in shared space and have automations.shared scope.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST workflows/automations/{id}/runs/{runId}/actions/retry

Path Parameters

id string

Required

The unique identifier for the automation.
runId string

Required

The unique identifier for the run.

Responses

204

OK Response

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.retryAutomationRun(
  '00000000-0000-0000-0000-000000000000',
  '00000000-0000-0000-0000-000000000000',
)

qlik automation run retry \
  --automationId '00000000-0000-0000-0000-000000000000' \
  --runId '00000000-0000-0000-0000-000000000000'

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

Forcefully stops an automation run immediately. Depending on the space the automation belongs to, the requesting user must meet the following requirement:

Private space: be the owner of the automation and have the automations.private scope
Shared space: be editor or operator in shared space and have automations.shared scope.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	POST workflows/automations/{id}/runs/{runId}/actions/stop

Path Parameters

id string

Required

The unique identifier for the automation.
runId string

Required

The unique identifier for the run.

Responses

204

OK Response

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

404

Not found

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.stopAutomationRun(
  '00000000-0000-0000-0000-000000000000',
  '00000000-0000-0000-0000-000000000000',
)

qlik automation run stop \
  --automationId '00000000-0000-0000-0000-000000000000' \
  --runId '00000000-0000-0000-0000-000000000000'

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

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

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Replaced by	GET workflows/automations/usage

Query Parameters

filter string

Required
Indicates how the metrics should be filtered using a SCIM-style expression. Available parameters:
- name (specify one or more enums to return specific metrics. Supported enum values: runs, scheduledRuns, triggeredRuns, webhookRuns, duration, bandwidthIn, bandwidthOut)
- date (return a metric for a specific date or range of dates, e.g. "2025-08-01")
breakdownBy string

If specified, result will be broken apart for each automation

Responses

200

OK Response

application/json object
Show application/json properties
- data array of objects
  
  Show data properties
  
  date string
  
  Required Filterable
  
  The date for the metric
  
  name string
  
  Required Filterable
  
  The name for the metric
  
  Can be one of: "runs""scheduledRun""triggeredRun""webhookRuns""duration""bandwidthIn""bandwidthOut"
  maxLength = 50
  
  value integer
  
  Required
  
  The value count of the metric
  
  automation object
  
  Show automation properties
  
  guid string
  
  The unique identifier for the automation.
  
  name string
  
  The name for the automation.
  
  maxLength = 50
  
  ownerId string
  
  The unique identifier for the user who owns the automation

400

Bad Request

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

401

Unauthorized

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

403

Forbidden

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

500

Internal Server Error

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

503

Service Unavailable

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The unique code for the error
  
  title string
  
  Required
  
  A summary of what went wrong
  
  detail string
  
  May be used to provide additional details
- traceId string
  
  A way to trace the source of the error.

GET /api/v1/automations/usage

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.automations.getAutomationsUsageMetrics(
  {
    filter:
      'date ge "2025-08-07" and date le "2025-08-12"',
  },
)

qlik automation usage ls \
  --filter 'date ge "2025-08-07" and date le "2025-08-12"'

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

Example Response

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

Automations

Endpoints

List automations

Facts

Query Parameters

Responses

200

400

401

403

500

503

Example Response

Create an automation

Facts

Request Body

Responses

201

400

401

403

500

503

Example Response

Get an automation

Facts

Path Parameters

Responses

200

400

401

403

404

500

503

Example Response

Update an automation

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

500

503

Example Response

Delete an automation

Facts

Path Parameters

Responses

204

401

403

404

500

503

Change automation owner

Facts

Path Parameters

Request Body

Responses

204

400

401

403

404

500

503

Change automation space

Facts

Path Parameters

Request Body

Responses

204

400

401

403