Skip to content

Automations

Qlik Application Automation is a visual, no-code approach to connecting applications.

Endpoints

Skip to section
GET/v1/automations
POST/v1/automations
GET/v1/automations/{id}
PUT/v1/automations/{id}
DELETE/v1/automations/{id}
POST/v1/automations/{id}/actions/copy
POST/v1/automations/{id}/actions/disable
POST/v1/automations/{id}/actions/enable
POST/v1/automations/{id}/actions/move
GET/v1/automations/{id}/runs
POST/v1/automations/{id}/runs
GET/v1/automations/{id}/runs/{runId}
POST/v1/automations/{id}/runs/{runId}/actions/export
POST/v1/automations/{id}/runs/{runId}/actions/retry
POST/v1/automations/{id}/runs/{runId}/actions/stop
GET/v1/automations/settings
PUT/v1/automations/settings
GET/v1/automations/usage

Retrieves a list of automations

managebuild

Facts GET /v1/automations

Rate limit
required
Tier 1 (1000 requests per minute)

Query Parameters GET /v1/automations

filter
string

Allowed filters: name, runMode, lastRunStatus, ownerId

limit
default=100, minimum=1, maximum=200
integer

The number of automations to retrieve.

sort
default='id'
string

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

Enum:

id

name

runMode

state

createdAt

updatedAt

lastRunAt

lastRunStatus

+id

+name

+runMode

+state

+createdAt

+updatedAt

+lastRunAt

+lastRunStatus

-id

-name

-runMode

-state

-createdAt

-updatedAt

-lastRunAt

-lastRunStatus

Responses GET /v1/automations

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

503
application/json

Service Unavailable

GET/v1/automations

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

Response GET /v1/automations

{
  "data": [
    {
      "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
      "name": "string",
      "state": "available",
      "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
      "runMode": "triggered",
      "createdAt": "2021-12-23T12:28:21.000000Z",
      "lastRunAt": "2021-12-23T12:28:21.000000Z",
      "updatedAt": "2021-12-23T12:28:21.000000Z",
      "description": "string",
      "lastRunStatus": "finished"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}

Create an automation

managebuild

Facts POST /v1/automations

Rate limit
required
Tier 2 (100 requests per minute)

Request Body POST /v1/automations

Automation object to create

Responses POST /v1/automations

201

Created

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

503
application/json

Service Unavailable

POST/v1/automations

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

Request POST /v1/automations

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

Response POST /v1/automations

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

Retrieves an automation

managebuild

Facts GET /v1/automations/{id}

Rate limit
required
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/automations/{id}

id
required
string

The unique identifier for the automation.

Responses GET /v1/automations/{id}

200

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

GET/v1/automations/{id}

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

Response GET /v1/automations/{id}

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

Update an automation

managebuild

Facts PUT /v1/automations/{id}

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters PUT /v1/automations/{id}

id
required
string

The unique identifier for the automation.

Request Body PUT /v1/automations/{id}

Automation object to update

Responses PUT /v1/automations/{id}

200

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

PUT/v1/automations/{id}

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

Request PUT /v1/automations/{id}

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

Response PUT /v1/automations/{id}

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

Delete an automation

managebuild

Facts DELETE /v1/automations/{id}

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/automations/{id}

id
required
string

The unique identifier for the automation.

Responses DELETE /v1/automations/{id}

204
object

No Content

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

DELETE/v1/automations/{id}

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

Copy an automation.

managebuild

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

Rate limit
required
Tier 2 (100 requests per minute)

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

id
required
string

The unique identifier for the automation.

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

name
application/json
string

Name of the new automation.

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

id
application/json
string

Created

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

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

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

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

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

Disables an automation.

managebuild

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

Rate limit
required
Tier 2 (100 requests per minute)

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

id
required
string

The unique identifier for the automation.

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

204
object

No Content

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

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

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

Enable an automation.

managebuild

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

Rate limit
required
Tier 2 (100 requests per minute)

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

id
required
string

The unique identifier for the automation.

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

204
object

No Content

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

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

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

Move an automation to a different user.

managebuild

This step will remove the history and change logs of this automation. All linked connections used inside an automation will be detached.

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

Rate limit
required
Tier 2 (100 requests per minute)

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

id
required
string<uuid>

The unique identifier for the automation.

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

userId
application/json
string

No description

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

204
object

No Content

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

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

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

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

"sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"

Retrieves a list of runs for a specific automation.

managebuild

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

Rate limit
required
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/automations/{id}/runs

id
required
string<uuid>

The unique identifier for the automation.

Query Parameters GET /v1/automations/{id}/runs

filter
string

Allowed filters: status, context, startTime and title

limit
default=10, minimum=1, maximum=200
integer

The number of runs to retrieve.

sort
default='id'
string

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

Enum:

id

status

startTime

-id

-status

-startTime

+id

+status

+startTime

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

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

GET/v1/automations/{id}/runs

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

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

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

Create a run

managebuild

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

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters POST /v1/automations/{id}/runs

id
required
string

The unique identifier for the automation.

Request Body POST /v1/automations/{id}/runs

application/json

Run object to create

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

201
application/json

Created

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

POST/v1/automations/{id}/runs

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/{id}/runs" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"id":"d452d100-9b0b-11ec-b199-8323e1031c3e","inputs":{},"context":"api"}'

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

{
  "id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
  "inputs": {},
  "context": "api"
}

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

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

Retrieves a run

managebuild

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

Rate limit
required
Tier 1 (1000 requests per minute)

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

id
required
string

The unique identifier for the automation.

runId
required
string

The unique identifier for the run.

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

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

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

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

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

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

Export a run.

managebuild

Creates a temporary pre-signed AWS S3 URL to download the raw logs of a completed run. This URL is valid for 5 minutes.

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

Rate limit
required
Tier 2 (100 requests per minute)

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

id
required
string

The unique identifier for the automation.

runId
required
string

The unique identifier for the run.

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

url
application/json
string

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

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

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

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

{
  "url": "https://<bucket>.s3.<region>.amazonaws.com/<run>.json"
}

Retry a run.

managebuild

This action allows you to retry a specific run by creating a new run using the same inputs.

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

Rate limit
required
Tier 2 (100 requests per minute)

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

id
required
string

The unique identifier for the automation.

runId
required
string

The unique identifier for the run.

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

204
object

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

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

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

Stop a running automation.

managebuild

Force a run to be stopped immediately.

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

Rate limit
required
Tier 2 (100 requests per minute)

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

id
required
string

The unique identifier for the automation.

runId
required
string

The unique identifier for the run.

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

204
object

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

404
application/json

Not found

500
application/json

Internal Server Error

503
application/json

Service Unavailable

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

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

Retrieves the automation settings.

managebuilddeprecated

Facts GET /v1/automations/settings

Rate limit
required
Tier 1 (1000 requests per minute)

Responses GET /v1/automations/settings

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

503
application/json

Service Unavailable

GET/v1/automations/settings

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

Response GET /v1/automations/settings

{
  "automationsEnabled": true
}

Update the automation settings.

managebuilddeprecated

Facts PUT /v1/automations/settings

Rate limit
required
Tier 2 (100 requests per minute)

Request Body PUT /v1/automations/settings

application/json

No description

Responses PUT /v1/automations/settings

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

503
application/json

Service Unavailable

PUT/v1/automations/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/automations/settings" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"automationsEnabled":true}'

Request PUT /v1/automations/settings

{
  "automationsEnabled": true
}

Response PUT /v1/automations/settings

{
  "automationsEnabled": true
}

Retrieves all automation usage for a tenant

managebuild

Limitations:

  • Maximum 1000 metrics per API call

Facts GET /v1/automations/usage

Rate limit
required
Tier 1 (1000 requests per minute)

Query Parameters GET /v1/automations/usage

filter
required
string

Indicates how the metrics should be filtered

breakdownBy
string

If specified, result will be broken apart for each automation

Responses GET /v1/automations/usage

200
application/json

OK Response

400
application/json

Bad Request

401
application/json

Unauthorized

403
application/json

Forbidden

500
application/json

Internal Server Error

503
application/json

Service Unavailable

GET/v1/automations/usage

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

Response GET /v1/automations/usage

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

BadRequest

Bad Request

Forbidden

Forbidden

InternalServerError

Internal Server Error

NotFound

Not found

ServiceUnavailable

Service Unavailable

Unauthorized

Unauthorized

AutomationDetailRequestObject

object

Properties

name
string

No description

state
default='available'
string

No description

Enum:

available

unavailable

disabled

schedules

No description

workspace
object

The workspace generated by the Qlik Application Automations editor.

description
string

No description

AutomationDetailResponseObject

object

Properties

id
string<uuid>

No description

name
string

No description

state
default='available'
string

No description

Enum:

available

unavailable

disabled

lastRun

No description

ownerId
string

No description

runMode
string

No description

Enum:

manual

scheduled

triggered

webhook

createdAt
string<date-time>

No description

lastRunAt
string<date-time>

No description

schedules

No description

updatedAt
string<date-time>

No description

workspace
object

The workspace generated by the Qlik Application Automations editor.

snippetIds
Array<string>

A list of snippets used inside the workspace.

description
string

No description

endpointIds
Array<string>

A list of endpoints used inside the workspace.

connectorIds
Array<string>

A list of connectors used inside the workspace.

lastRunStatus
string

No description

Enum:

failed

finished

finished with warnings

must stop

not started

paused

running

starting

stopped

executionToken
string

No description

AutomationList

object

Properties

data

No description

links

No description

AutomationListObject

object

Properties

id
string<uuid>

No description

name
filterable
string

No description

state
default='available'
string

No description

Enum:

available

unavailable

disabled

ownerId
filterable
string

No description

runMode
filterable
string

No description

Enum:

manual

scheduled

triggered

webhook

createdAt
string<date-time>

No description

lastRunAt
string<date-time>

No description

updatedAt
string<date-time>

No description

description
string

No description

lastRunStatus
filterable
string

No description

Enum:

failed

finished

finished with warnings

must stop

not started

paused

running

starting

stopped

AutomationUsageObject

object

Properties

guid
string

The unique identifier for the automation.

name
string

The name for the automation.

ownerId
string

The unique identifier for the user who owns the automation

Error

object

Properties

code
required
string

The unique code for the error

title
required
string

A summary of what went wrong

detail
string

May be used to provide additional details

ErrorResponse

object

Properties

errors

No description

traceId
string

A way to trace the source of the error.

Properties

next

No description

prev

No description

Properties

href
string

The URL to a resource request

RunDetailRequestObject

object

Properties

id
string<uuid>

No description

inputs
object

No description

context
required
string

The source that triggers the automation will set the context.

Enum:

api

RunDetailResponseObject

object

Properties

id
string<uuid>

No description

error
object

No description

title
string

No description

inputs
object

No description

status
string

No description

Enum:

failed

finished

finished with warnings

must stop

not started

running

starting

stopped

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).

Enum:

test_run

editor

detail

api_sync

api_async

webhook

lookup

metrics

No description

stopTime
string<date-time>

No description

createdAt
string<date-time>

No description

isTestRun
boolean

No description

startTime
string<date-time>

No description

updatedAt
string<date-time>

No description

isArchived
boolean

No description

expectedInputs
object

No description

scheduledStartTime
string<date-time>

No description

RunList

object

Properties

data

No description

links

No description

RunListObject

object

Properties

id
string<uuid>

No description

error
object

No description

title
string

No description

status
filterable
string

No description

Enum:

failed

finished

finished with warnings

must stop

not started

running

starting

stopped

context
string

No description

Enum:

test_run

editor

detail

api_sync

api_async

webhook

lookup

stopTime
string<date-time>

No description

createdAt
string

No description

isTestRun
boolean

No description

startTime
string<date-time>

No description

updatedAt
string

No description

isArchived
boolean

No description

scheduledStartTime
string<date-time>

No description

ScheduleRequestObject

object

Properties

stopAt
string

No description

startAt
string

No description

interval
integer

time in seconds.

timezone
string

No description

ScheduleResponseObject

object

Properties

id
string<uuid>

No description

stopAt
string

No description

startAt
string

No description

interval
integer

time in seconds.

timezone
string

No description

lastStartedAt
string<date-time>

No description

SettingsObject

object

Properties

automationsEnabled
boolean

No description

UsageList

object

Properties

data

No description

UsageObject

object

Properties

date
required
string

The date for the metric

name
required
string

The name for the metric

Enum:

runs

scheduledRun

triggeredRun

webhookRuns

duration

bandwidthIn

bandwidthOut

value
required
integer

The value count of the metric

automation

No description

v0.879.8
Was this page helpful?