Automation connections

Automation Connections are used by Qlik Automate connectors during automation execution.

Preferred API

This API replaces the legacy Automation connections API. Use this API for all new implementations.

Endpoints

GET

/api/workflows/automation-connections
POST

/api/workflows/automation-connections
GET

/api/workflows/automation-connections/{id}
PUT

/api/workflows/automation-connections/{id}
DELETE

/api/workflows/automation-connections/{id}
POST

/api/workflows/automation-connections/{id}/actions/change-owner
POST

/api/workflows/automation-connections/{id}/actions/change-space
POST

/api/workflows/automation-connections/{id}/actions/check

Retrieves a list of automation connections the requesting user has access to.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Replaces	GET v1/automation-connections

Query Parameters

cursor string

Pagination cursor returned from a previous request.
filter string

Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId.
limit integer

The number of automation connections to retrieve.

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

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

default = false
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""createdAt""updatedAt""+id""+name""+createdAt""+updatedAt""-id""-name""-createdAt""-updatedAt"
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 of an automation connection.
  
  name string
  
  Filterable
  
  The name of an automation connection.
  
  ownerId string
  
  Filterable
  
  The unique identifier of the owner of the automation connection.
  
  spaceId string
  
  Filterable
  
  The space ID of the automation connection.
  
  createdAt string
  
  The timestamp when the automation connection is created.
  
  format = "date-time"
  
  updatedAt string
  
  The timestamp when the automation connection is updated.
  
  format = "date-time"
  
  connectorId string
  
  Filterable
  
  The unique identifier of the connector the automation connection is created from.
  
  isConnected boolean
  
  Returns true if the automtion connection is connected.
- 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/workflows/automation-connections

import { createQlikApi } from '@qlik/api'

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

await qlik.workflows.automationConnections.getAutomationConnections(
  {},
)

qlik workflows automation-connection ls

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

Example Response

{
  "data": [
    {
      "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
      "name": "auto conn",
      "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
      "spaceId": "5f0f78b239ff4f0001234567",
      "createdAt": "2021-12-23T12:28:21.000000Z",
      "updatedAt": "2021-12-23T12:28:21.000000Z",
      "connectorId": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
      "isConnected": true
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}

Creates a new connection object from an automation connector.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automation-connections

Request Body

Required

The automation object to create.

application/json object
Show application/json properties
- name string
  
  The name of the created automation connection.
- params array of objects
  
  Show params properties
  
  name string
  
  The name of the automation connection parameter.
  
  value string
  
  The value of the automation connection parameter option.
- spaceId string
  
  The unique identifier of the space in which the automation connection is created.
- connectorId string
  
  Required
  
  The unique identifier of the connector from which the automation connection is created.

Responses

201

Created

application/json object
Show application/json properties
- id string
  
  The unique identifier of the automation connection.
- name string
  
  The name of the automation connection.
- error object
  
  This contains the error message if a connection is being created with an issue.
- params array of objects
  
  Show params properties
  
  id string
  
  The unique identifier of the automation connection parameter.
  
  meta array of undefineds
  
  The metadata of the automation connection parameter.
  
  name string
  
  The name of the automation connection parameter.
  
  order integer
  
  The order that the automation connection configuration fields should be displayed in.
  
  value string
  
  The value of the automation connection parameter.
  
  fieldType string
  
  The field type of the automation connection parameter.
  
  isOptional boolean
  
  When true, the parameter is optional.
  
  exampleValue string
  
  The example value of the automation connection parameter.
  
  paramOptions array of objects
  
  Show paramOptions properties
  
  id string
  
  The unique identifier of the automation connection parameter option.
  
  value string
  
  The value of the automation connection parameter option.
  
  documentation string
  
  The documentation of the automation connection parameter.
- ownerId string
  
  The unique identifier of the owner of the automation connection.
- spaceId string
  
  The space ID of the automation connection.
- redirect string
  
  The redirect of the OAuth account.
- createdAt string
  
  The timestamp when the automation connection was created.
  
  format = "date-time"
- updatedAt string
  
  The timestamp when the automation connection was updated.
  
  format = "date-time"
- connectorId string
  
  The unique identifier of the automation connector.
- isConnected boolean
  
  The connection status of the automation connection. When true, the automation connection is connected.
- oauthAccountName string
  
  The name of the OAuth account associated with the automation connection.

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/workflows/automation-connections

import { createQlikApi } from '@qlik/api'

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

await qlik.workflows.automationConnections.createAutomationConnection(
  {
    connectorId:
      '3004e850-1985-11ee-b6df-8d800b305320',
    name: 'connection',
    params: [
      {
        name: 'username',
        value: 'example-username',
      },
    ],
    spaceId: '5f0f78b239ff4f0001234567',
  },
)

qlik workflows automation-connection create \
  --connectorId '3004e850-1985-11ee-b6df-8d800b305320'

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automation-connections" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"connection","params":[{"name":"username","value":"example-username"}],"spaceId":"5f0f78b239ff4f0001234567","connectorId":"3004e850-1985-11ee-b6df-8d800b305320"}'

Example Response

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "name": "connection",
  "error": {},
  "params": [
    {
      "id": "39a90780-8874-11ee-b16c-89512345678",
      "meta": [],
      "name": "region",
      "order": 1,
      "value": "string",
      "fieldType": "enum",
      "isOptional": "false",
      "exampleValue": "string",
      "paramOptions": [
        {
          "id": "39a90780-8874-11ee-b16c-89512345678",
          "value": "string"
        }
      ],
      "documentation": "string"
    }
  ],
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "spaceId": "5f0f78b239ff4f0001234567",
  "redirect": "string",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "connectorId": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "isConnected": true,
  "oauthAccountName": "oauth"
}

Returns details about the specified automation connection.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Replaces	GET v1/automation-connections/{id}

Path Parameters

id string

Required

The unique identifier for the automation connection.

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  The unique identifier of the automation connection.
- name string
  
  The name of the automation connection.
- error object
  
  This contains the error message if a connection is being created with an issue.
- params array of objects
  
  Show params properties
  
  id string
  
  The unique identifier of the automation connection parameter.
  
  meta array of undefineds
  
  The metadata of the automation connection parameter.
  
  name string
  
  The name of the automation connection parameter.
  
  order integer
  
  The order that the automation connection configuration fields should be displayed in.
  
  value string
  
  The value of the automation connection parameter.
  
  fieldType string
  
  The field type of the automation connection parameter.
  
  isOptional boolean
  
  When true, the parameter is optional.
  
  exampleValue string
  
  The example value of the automation connection parameter.
  
  paramOptions array of objects
  
  Show paramOptions properties
  
  id string
  
  The unique identifier of the automation connection parameter option.
  
  value string
  
  The value of the automation connection parameter option.
  
  documentation string
  
  The documentation of the automation connection parameter.
- ownerId string
  
  The unique identifier of the owner of the automation connection.
- spaceId string
  
  The space ID of the automation connection.
- redirect string
  
  The redirect of the OAuth account.
- createdAt string
  
  The timestamp when the automation connection was created.
  
  format = "date-time"
- updatedAt string
  
  The timestamp when the automation connection was updated.
  
  format = "date-time"
- connectorId string
  
  The unique identifier of the automation connector.
- isConnected boolean
  
  The connection status of the automation connection. When true, the automation connection is connected.
- oauthAccountName string
  
  The name of the OAuth account associated with the automation connection.

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/workflows/automation-connections/{id}

import { createQlikApi } from '@qlik/api'

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

await qlik.workflows.automationConnections.getAutomationConnection(
  'd6321ebd-d9e8-48fe-9d86-97dbd473bf60',
)

qlik workflows automation-connection get 'd6321ebd-d9e8-48fe-9d86-97dbd473bf60'

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

Example Response

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "name": "connection",
  "error": {},
  "params": [
    {
      "id": "39a90780-8874-11ee-b16c-89512345678",
      "meta": [],
      "name": "region",
      "order": 1,
      "value": "string",
      "fieldType": "enum",
      "isOptional": "false",
      "exampleValue": "string",
      "paramOptions": [
        {
          "id": "39a90780-8874-11ee-b16c-89512345678",
          "value": "string"
        }
      ],
      "documentation": "string"
    }
  ],
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "spaceId": "5f0f78b239ff4f0001234567",
  "redirect": "string",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "connectorId": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "isConnected": true,
  "oauthAccountName": "oauth"
}

Updates the specified properties of an automation connection.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	PUT v1/automation-connections/{id}

Path Parameters

id string

Required

The unique identifier for the automation connection.

Request Body

Required

The automation connection object to update.

application/json object
Show application/json properties
- name string
  
  The new name of the automation connection to be renamed to.
- params array of objects
  
  Show params properties
  
  id string
  
  The unique identifier of the automation connection parameter option.
  
  value string
  
  The value of the automation connection parameter option.

Responses

200

OK Response

application/json object
Show application/json properties
- id string
  
  The unique identifier of the automation connection.
- name string
  
  The name of the automation connection.
- error object
  
  This contains the error message if a connection is being created with an issue.
- params array of objects
  
  Show params properties
  
  id string
  
  The unique identifier of the automation connection parameter.
  
  meta array of undefineds
  
  The metadata of the automation connection parameter.
  
  name string
  
  The name of the automation connection parameter.
  
  order integer
  
  The order that the automation connection configuration fields should be displayed in.
  
  value string
  
  The value of the automation connection parameter.
  
  fieldType string
  
  The field type of the automation connection parameter.
  
  isOptional boolean
  
  When true, the parameter is optional.
  
  exampleValue string
  
  The example value of the automation connection parameter.
  
  paramOptions array of objects
  
  Show paramOptions properties
  
  id string
  
  The unique identifier of the automation connection parameter option.
  
  value string
  
  The value of the automation connection parameter option.
  
  documentation string
  
  The documentation of the automation connection parameter.
- ownerId string
  
  The unique identifier of the owner of the automation connection.
- spaceId string
  
  The space ID of the automation connection.
- redirect string
  
  The redirect of the OAuth account.
- createdAt string
  
  The timestamp when the automation connection was created.
  
  format = "date-time"
- updatedAt string
  
  The timestamp when the automation connection was updated.
  
  format = "date-time"
- connectorId string
  
  The unique identifier of the automation connector.
- isConnected boolean
  
  The connection status of the automation connection. When true, the automation connection is connected.
- oauthAccountName string
  
  The name of the OAuth account associated with the automation connection.

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.

409

Conflict with the current state of the resource

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/workflows/automation-connections/{id}

import { createQlikApi } from '@qlik/api'

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

await qlik.workflows.automationConnections.updateAutomationConnection(
  '00000000-0000-0000-0000-000000000000',
  {
    name: 'connection',
    params: [
      {
        id: '39a90780-8874-11ee-b16c-89512345678',
        value: '100',
      },
    ],
  },
)

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

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automation-connections/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"connection","params":[{"id":"39a90780-8874-11ee-b16c-89512345678","value":"100"}]}'

Example Response

{
  "id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "name": "connection",
  "error": {},
  "params": [
    {
      "id": "39a90780-8874-11ee-b16c-89512345678",
      "meta": [],
      "name": "region",
      "order": 1,
      "value": "string",
      "fieldType": "enum",
      "isOptional": "false",
      "exampleValue": "string",
      "paramOptions": [
        {
          "id": "39a90780-8874-11ee-b16c-89512345678",
          "value": "string"
        }
      ],
      "documentation": "string"
    }
  ],
  "ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
  "spaceId": "5f0f78b239ff4f0001234567",
  "redirect": "string",
  "createdAt": "2021-12-23T12:28:21.000000Z",
  "updatedAt": "2021-12-23T12:28:21.000000Z",
  "connectorId": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
  "isConnected": true,
  "oauthAccountName": "oauth"
}

Deletes the specified automation connection.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	DELETE v1/automation-connections/{id}

Query Parameters

forced boolean

When true, the automation connection will be deleted regardless of its usage by any automations.

default = false

Path Parameters

id string

Required

The unique identifier for the automation connection.

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.

DELETE /api/workflows/automation-connections/{id}

import { createQlikApi } from '@qlik/api'

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

await qlik.workflows.automationConnections.deleteAutomationConnection(
  '00000000-0000-0000-0000-000000000000',
  {},
)

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

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

Changes the owner of an automation connection by specifying a new owner.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automation-connections/{id}/actions/change-owner

Path Parameters

id string

Required

The unique identifier for the automation connection.

Request Body

Required

The new owner of the automation connection.

application/json object
Show application/json properties
- userId string
  
  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/workflows/automation-connections/{id}/actions/change-owner

import { createQlikApi } from '@qlik/api'

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

await qlik.workflows.automationConnections.changeOwnerAutomationConnection(
  '00000000-0000-0000-0000-000000000000',
  { userId: 'sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy' },
)

qlik workflows automation-connection change-owner '00000000-0000-0000-0000-000000000000'

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automation-connections/{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 connection by specifying a new space.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automation-connections/{id}/actions/change-space

Path Parameters

id string

Required

The unique identifier for the automation connection.

Request Body

Required

The new space of the automation connection.

application/json object
Show application/json properties
- spaceId string
  
  The unique identifier of the new space. Leave empty to move to the owner's personal 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/workflows/automation-connections/{id}/actions/change-space

import { createQlikApi } from '@qlik/api'

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

await qlik.workflows.automationConnections.changeSpaceAutomationConnection(
  '00000000-0000-0000-0000-000000000000',
  { spaceId: '5f0f78b239ff4f0001234567' },
)

qlik workflows automation-connection change-space '00000000-0000-0000-0000-000000000000'

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

Tries to validate and checks the connection status of an automation connection.

Facts

	Rate limit	Tier 2 (100 requests per minute)
	Replaces	POST v1/automation-connections/{id}/actions/check

Path Parameters

id string

Required

The unique identifier for the automation connection.

Responses

200

OK Response

application/json object
Show application/json properties
- connected boolean
  
  The connection status of the automation connection. When true, the automation connection is connected.
- is_connected boolean
  
  The connection status of the automation connection. When true, the automation connection is connected.

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/workflows/automation-connections/{id}/actions/check

import { createQlikApi } from '@qlik/api'

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

await qlik.workflows.automationConnections.checkAutomationConnection(
  '00000000-0000-0000-0000-000000000000',
)

qlik workflows automation-connection check '00000000-0000-0000-0000-000000000000'

curl "https://{tenant}.{region}.qlikcloud.com/api/workflows/automation-connections/{id}/actions/check" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "connected": true,
  "is_connected": true
}

Automation connections

Endpoints

List automation connections

Facts

Query Parameters

Responses

200

400

401

403

500

503

Example Response

Create an automation connection

Facts

Request Body

Responses

201

400

401

403

500

503

Example Response

Get an automation connection

Facts

Path Parameters

Responses

200

400

401

403

404

500

503

Example Response

Update an automation connection

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

409

500

503

Example Response

Delete an automation connection

Facts

Query Parameters

Path Parameters

Responses

204

400

401

403

404

500

503

Change automation connection owner

Facts

Path Parameters

Request Body

Responses

204

400

401

403

404

500

503

Change automation connection space

Facts

Path Parameters

Request Body

Responses

204