Automation connectors

Automation connectors let you integrate third-party services and applications into your data analytics workflows. Use this API to discover available connectors and understand billing characteristics.

Download specification

Endpoints

GET

/api/v1/automation-connectors

Retrieves a list of automation connectors.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories

Query Parameters

filterstring

Filters the result based on the specified criteria: name.
limitinteger

The number of automation connectors to retrieve.

minimum = 1, maximum = 200, default = 100, default = 100
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: "name""+name""-name"

default = "id"

Responses

200

OK Response

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  
  format = "uuid"
  
  namestring
  Filterable
  
  The name of an automation connector.
  
  billableboolean
  
  Indicates if the connector is billable.
- 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/v1/automation-connectors

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

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

This API is not included yet in qlik-cli

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

Example Response

{
  "data": [
    {
      "id": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
      "name": "Airtable",
      "billable": "true"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}