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

filterstring

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

The number of automation connections to retrieve.

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

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

default = false
sortstring

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/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  
  The unique identifier of an automation connection.
  
  namestring
  Filterable
  
  The name of an automation connection.
  
  ownerIdstring
  Filterable
  
  The unique identifier of the owner of the automation connection.
  
  spaceIdstring
  Filterable
  
  The space ID of the automation connection.
  
  createdAtstring
  
  The timestamp when the automation connection is created.
  
  format = "date-time"
  
  updatedAtstring
  
  The timestamp when the automation connection is updated.
  
  format = "date-time"
  
  connectorIdstring
  Filterable
  
  The unique identifier of the connector the automation connection is created from.
  
  isConnectedboolean
  
  Returns true if the automtion connection is connected.
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  The URL to a resource request
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  The URL to a resource request

400

Bad Request

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

401

Unauthorized

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

403

Forbidden

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

500

Internal Server Error

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

503

Service Unavailable

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

GET /api/workflows/automation-connections

// qlik-api has not implemented support for `GET /api/workflows/automation-connections` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/workflows/automation-connections',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

This API is not included yet in qlik-cli

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/jsonobject
Show application/json properties
- namestring
  
  The name of the created automation connection.
- paramsarray of objects
  
  Show params properties
  
  namestring
  
  The name of the automation connection parameter.
  
  valuestring
  
  The value of the automation connection parameter option.
- spaceIdstring
  
  The unique identifier of the space in which the automation connection is created.
- connectorIdstring
  Required
  
  The unique identifier of the connector from which the automation connection is created.

Responses

201

Created

application/jsonobject
Show application/json properties
- idstring
  
  The unique identifier of the automation connection.
- namestring
  
  The name of the automation connection.
- errorobject
  
  This contains the error message if a connection is being created with an issue.
- paramsarray of objects
  
  Show params properties
  
  idstring
  
  The unique identifier of the automation connection parameter.
  
  metaarray of undefineds
  
  The metadata of the automation connection parameter.
  
  namestring
  
  The name of the automation connection parameter.
  
  orderinteger
  
  The order that the automation connection configuration fields should be displayed in.
  
  valuestring
  
  The value of the automation connection parameter.
  
  fieldTypestring
  
  The field type of the automation connection parameter.
  
  isOptionalboolean
  
  When true, the parameter is optional.
  
  exampleValuestring
  
  The example value of the automation connection parameter.
  
  paramOptionsarray of objects
  
  Show paramOptions properties
  
  idstring
  
  The unique identifier of the automation connection parameter option.
  
  valuestring
  
  The value of the automation connection parameter option.
  
  documentationstring
  
  The documentation of the automation connection parameter.
- ownerIdstring
  
  The unique identifier of the owner of the automation connection.
- spaceIdstring
  
  The space ID of the automation connection.
- redirectstring
  
  The redirect of the OAuth account.
- createdAtstring
  
  The timestamp when the automation connection was created.
  
  format = "date-time"
- updatedAtstring
  
  The timestamp when the automation connection was updated.
  
  format = "date-time"
- connectorIdstring
  
  The unique identifier of the automation connector.
- isConnectedboolean
  
  The connection status of the automation connection. When true, the automation connection is connected.
- oauthAccountNamestring
  
  The name of the OAuth account associated with the automation connection.

400

Bad Request

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

401

Unauthorized

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

403

Forbidden

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

500

Internal Server Error

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

503

Service Unavailable

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

POST /api/workflows/automation-connections

// qlik-api has not implemented support for `POST /api/workflows/automation-connections` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/workflows/automation-connections',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'connection',
      params: [
        {
          name: 'username',
          value: 'example-username',
        },
      ],
      spaceId: '5f0f78b239ff4f0001234567',
      connectorId:
        '3004e850-1985-11ee-b6df-8d800b305320',
    }),
  },
)

This API is not included yet in qlik-cli

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": [
        null
      ],
      "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

idstring
Required

The unique identifier for the automation connection.

Responses

200

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  The unique identifier of the automation connection.
- namestring
  
  The name of the automation connection.
- errorobject
  
  This contains the error message if a connection is being created with an issue.
- paramsarray of objects
  
  Show params properties
  
  idstring
  
  The unique identifier of the automation connection parameter.
  
  metaarray of undefineds
  
  The metadata of the automation connection parameter.
  
  namestring
  
  The name of the automation connection parameter.
  
  orderinteger
  
  The order that the automation connection configuration fields should be displayed in.
  
  valuestring
  
  The value of the automation connection parameter.
  
  fieldTypestring
  
  The field type of the automation connection parameter.
  
  isOptionalboolean
  
  When true, the parameter is optional.
  
  exampleValuestring
  
  The example value of the automation connection parameter.
  
  paramOptionsarray of objects
  
  Show paramOptions properties
  
  idstring
  
  The unique identifier of the automation connection parameter option.
  
  valuestring
  
  The value of the automation connection parameter option.
  
  documentationstring
  
  The documentation of the automation connection parameter.
- ownerIdstring
  
  The unique identifier of the owner of the automation connection.
- spaceIdstring
  
  The space ID of the automation connection.
- redirectstring
  
  The redirect of the OAuth account.
- createdAtstring
  
  The timestamp when the automation connection was created.
  
  format = "date-time"
- updatedAtstring
  
  The timestamp when the automation connection was updated.
  
  format = "date-time"
- connectorIdstring
  
  The unique identifier of the automation connector.
- isConnectedboolean
  
  The connection status of the automation connection. When true, the automation connection is connected.
- oauthAccountNamestring
  
  The name of the OAuth account associated with the automation connection.

400

Bad Request

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

401

Unauthorized

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

403

Forbidden

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

404

Not found

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

500

Internal Server Error

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

503

Service Unavailable

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

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

// qlik-api has not implemented support for `GET /api/workflows/automation-connections/{id}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/workflows/automation-connections/{id}',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

This API is not included yet in qlik-cli

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": [
        null
      ],
      "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

idstring
Required

The unique identifier for the automation connection.

Request Body

Required

The automation connection object to update.

application/jsonobject
Show application/json properties
- namestring
  
  The new name of the automation connection to be renamed to.
- paramsarray of objects
  
  Show params properties
  
  idstring
  
  The unique identifier of the automation connection parameter option.
  
  valuestring
  
  The value of the automation connection parameter option.

Responses

200

OK Response

application/jsonobject
Show application/json properties
- idstring
  
  The unique identifier of the automation connection.
- namestring
  
  The name of the automation connection.
- errorobject
  
  This contains the error message if a connection is being created with an issue.
- paramsarray of objects
  
  Show params properties
  
  idstring
  
  The unique identifier of the automation connection parameter.
  
  metaarray of undefineds
  
  The metadata of the automation connection parameter.
  
  namestring
  
  The name of the automation connection parameter.
  
  orderinteger
  
  The order that the automation connection configuration fields should be displayed in.
  
  valuestring
  
  The value of the automation connection parameter.
  
  fieldTypestring
  
  The field type of the automation connection parameter.
  
  isOptionalboolean
  
  When true, the parameter is optional.
  
  exampleValuestring
  
  The example value of the automation connection parameter.
  
  paramOptionsarray of objects
  
  Show paramOptions properties
  
  idstring
  
  The unique identifier of the automation connection parameter option.
  
  valuestring
  
  The value of the automation connection parameter option.
  
  documentationstring
  
  The documentation of the automation connection parameter.
- ownerIdstring
  
  The unique identifier of the owner of the automation connection.
- spaceIdstring
  
  The space ID of the automation connection.
- redirectstring
  
  The redirect of the OAuth account.
- createdAtstring
  
  The timestamp when the automation connection was created.
  
  format = "date-time"
- updatedAtstring
  
  The timestamp when the automation connection was updated.
  
  format = "date-time"
- connectorIdstring
  
  The unique identifier of the automation connector.
- isConnectedboolean
  
  The connection status of the automation connection. When true, the automation connection is connected.
- oauthAccountNamestring
  
  The name of the OAuth account associated with the automation connection.

400

Bad Request

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

401

Unauthorized

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

403

Forbidden

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

404

Not found

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

409

Conflict with the current state of the resource

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

500

Internal Server Error

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

503

Service Unavailable

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

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

// qlik-api has not implemented support for `PUT /api/workflows/automation-connections/{id}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/workflows/automation-connections/{id}',
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'connection',
      params: [
        {
          id: '39a90780-8874-11ee-b16c-89512345678',
          value: '100',
        },
      ],
    }),
  },
)

This API is not included yet in qlik-cli

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": [
        null
      ],
      "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

forcedboolean

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

default = false

Path Parameters

idstring
Required

The unique identifier for the automation connection.

Responses

204

No Content

400

Bad Request

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

401

Unauthorized

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

403

Forbidden

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

404

Not found

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

500

Internal Server Error

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

503

Service Unavailable

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

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

// qlik-api has not implemented support for `DELETE /api/workflows/automation-connections/{id}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/workflows/automation-connections/{id}',
  {
    method: 'DELETE',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

This API is not included yet in qlik-cli

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

idstring
Required

The unique identifier for the automation connection.

Request Body

Required

The new owner of the automation connection.

application/jsonobject
Show application/json properties
- userIdstring
  
  The unique identifier of the new owner.

Responses

204

No Content

400

Bad Request

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

401

Unauthorized

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

403

Forbidden

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

404

Not found

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

500

Internal Server Error

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

503

Service Unavailable

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

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

// qlik-api has not implemented support for `POST /api/workflows/automation-connections/{id}/actions/change-owner` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/workflows/automation-connections/{id}/actions/change-owner',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      userId: 'sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy',
    }),
  },
)

This API is not included yet in qlik-cli

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

idstring
Required

The unique identifier for the automation connection.

Request Body

Required

The new space of the automation connection.

application/jsonobject
Show application/json properties
- spaceIdstring
  
  The unique identifier of the new space.

Responses

204

No Content

400

Bad Request

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

401

Unauthorized

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

403

Forbidden

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

404

Not found

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

500

Internal Server Error

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

503

Service Unavailable

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

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

// qlik-api has not implemented support for `POST /api/workflows/automation-connections/{id}/actions/change-space` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/workflows/automation-connections/{id}/actions/change-space',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      spaceId: '5f0f78b239ff4f0001234567',
    }),
  },
)

This API is not included yet in qlik-cli

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

idstring
Required

The unique identifier for the automation connection.

Responses

200

OK Response

application/jsonobject
Show application/json properties
- connectedboolean
  
  The connection status of the automation connection. When true, the automation connection is connected.
- is_connectedboolean
  
  The connection status of the automation connection. When true, the automation connection is connected.

400

Bad Request

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

401

Unauthorized

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

403

Forbidden

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

404

Not found

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

500

Internal Server Error

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

503

Service Unavailable

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

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

// qlik-api has not implemented support for `POST /api/workflows/automation-connections/{id}/actions/check` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/workflows/automation-connections/{id}/actions/check',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

This API is not included yet in qlik-cli

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