Automation connections
Automation Connections are used by Application Automation connectors during automation execution.
Endpoints
- GET/v1/automation-connections
- POST/v1/automation-connections
- GET/v1/automation-connections/{id}
- PUT/v1/automation-connections/{id}
- DELETE/v1/automation-connections/{id}
- POST/v1/automation-connections/{id}/actions/change-owner
- POST/v1/automation-connections/{id}/actions/change-space
- POST/v1/automation-connections/{id}/actions/check
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | managebuild |
Query Parameters
- filterstring
Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId.
- limitinteger
The number of automation connections to retrieve.
- listAllboolean
When true, list all connections. Restricted to tenant admins and analytics admins.
- 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"
Responses
200
application/json
OK Response
- application/jsonobject
application/json properties
- dataarray of objects
data properties
- idstring
The unique identifier of an automation connection.
- namestring
The name of an automation connection.
- ownerIdstring
The unique identifier of the owner of the automation connection.
- spaceIdstring
The space ID of the automation connection.
- createdAtstring
The timestamp when the automation connection is created.
- updatedAtstring
The timestamp when the automation connection is updated.
- connectorIdstring
The unique identifier of the connector the automation connection is created from.
- isConnectedboolean
Returns true if the automtion connection is connected.
-
- linksobject
links properties
- nextobject
next properties
- hrefstring
The URL to a resource request
-
- prevobject
prev properties
- hrefstring
The URL to a resource request
-
-
-
400
application/json
Bad Request
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
401
application/json
Unauthorized
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
403
application/json
Forbidden
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
500
application/json
Internal Server Error
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
503
application/json
Service Unavailable
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/automation-connections" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/automation-connections',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
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) |
Categories | managebuild |
Request Body
Requiredapplication/json
The automation object to create.
- application/jsonobject
application/json properties
- namestring
The name of the created automation connection.
- paramsarray of objects
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.
- connectorIdstringRequired
The unique identifier of the connector from which the automation connection is created.
-
Responses
201
application/json
Created
- application/jsonobject
application/json properties
- idstring
The unique identifier of the automation connection.
- dataobjectDeprecated
DEPRECATED. The content inside this property is also on the top level. Hense, this will be removed as duplicate.
data 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
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
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.
- updatedAtstring
The timestamp when the automation connection was updated.
- 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.
-
- 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
- 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.
- updatedAtstring
The timestamp when the automation connection was updated.
- 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
application/json
Bad Request
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
401
application/json
Unauthorized
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
403
application/json
Forbidden
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
500
application/json
Internal Server Error
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
503
application/json
Service Unavailable
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/automation-connections" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"connection","params":[{"name":"username","value":"string"}],"spaceId":"5f0f78b239ff4f0001234567","connectorId":"3004e850-1985-11ee-b6df-8d800b305320"}'
const https = require('https')
const data = JSON.stringify({"name":"connection","params":[{"name":"username","value":"string"}],"spaceId":"5f0f78b239ff4f0001234567","connectorId":"3004e850-1985-11ee-b6df-8d800b305320"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/automation-connections',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
{
"name": "connection",
"params": [
{
"name": "username",
"value": "string"
}
],
"spaceId": "5f0f78b239ff4f0001234567",
"connectorId": "3004e850-1985-11ee-b6df-8d800b305320"
}
Response
{
"id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
"data": {
"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"
},
"name": "connection",
"error": {},
"params": [
{}
],
"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) |
Categories | managebuild |
Path Parameters
- idstringRequired
The unique identifier for the automation connection.
Responses
200
application/json
OK Response
- application/jsonobject
application/json properties
- idstring
The unique identifier of the automation connection.
- dataobjectDeprecated
DEPRECATED. The content inside this property is also on the top level. Hense, this will be removed as duplicate.
data 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
- 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.
- updatedAtstring
The timestamp when the automation connection was updated.
- 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.
-
- 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
- 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.
- updatedAtstring
The timestamp when the automation connection was updated.
- 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
application/json
Bad Request
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
401
application/json
Unauthorized
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
403
application/json
Forbidden
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
404
application/json
Not found
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
500
application/json
Internal Server Error
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
503
application/json
Service Unavailable
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/automation-connections/{id}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/automation-connections/{id}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
"data": {
"id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
"name": "connection",
"error": {},
"params": [
{}
],
"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"
},
"name": "connection",
"error": {},
"params": [
{}
],
"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) |
Categories | managebuild |
Path Parameters
- idstringRequired
The unique identifier for the automation connection.
Request Body
Requiredapplication/json
The automation connection object to update.
- application/jsonobject
application/json properties
- namestring
The new name of the automation connection to be renamed to.
- paramsarray of objects
params properties
- idstring
The unique identifier of the automation connection parameter option.
- valuestring
The value of the automation connection parameter option.
-
-
Responses
200
application/json
OK Response
- application/jsonobject
application/json properties
- idstring
The unique identifier of the automation connection.
- dataobjectDeprecated
DEPRECATED. The content inside this property is also on the top level. Hense, this will be removed as duplicate.
data 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
- 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.
- updatedAtstring
The timestamp when the automation connection was updated.
- 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.
-
- 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
- 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.
- updatedAtstring
The timestamp when the automation connection was updated.
- 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
application/json
Bad Request
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
401
application/json
Unauthorized
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
403
application/json
Forbidden
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
404
application/json
Not found
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
500
application/json
Internal Server Error
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
503
application/json
Service Unavailable
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/automation-connections/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"connection","params":[{"id":"39a90780-8874-11ee-b16c-89512345678","value":"string"}]}'
const https = require('https')
const data = JSON.stringify({"name":"connection","params":[{"id":"39a90780-8874-11ee-b16c-89512345678","value":"string"}]})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/automation-connections/{id}',
'method': 'PUT',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
{
"name": "connection",
"params": [
{
"id": "39a90780-8874-11ee-b16c-89512345678",
"value": "string"
}
]
}
Response
{
"id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
"data": {
"id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
"name": "connection",
"error": {},
"params": [
{}
],
"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"
},
"name": "connection",
"error": {},
"params": [
{}
],
"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) |
Categories | managebuild |
Query Parameters
- forcedboolean
When true, the automation connection will be deleted regardless of its usage by any automations.
Path Parameters
- idstringRequired
The unique identifier for the automation connection.
Responses
204
No Content
400
application/json
Bad Request
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
401
application/json
Unauthorized
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
403
application/json
Forbidden
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
404
application/json
Not found
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
500
application/json
Internal Server Error
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
503
application/json
Service Unavailable
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/automation-connections/{id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/automation-connections/{id}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Changes the owner of an automation connection by specifying a new owner.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- idstringRequired
The unique identifier for the automation connection.
Request Body
Requiredapplication/json
The new owner of the automation connection.
- application/jsonobject
application/json properties
- userIdstring
The unique identifier of the new owner.
-
Responses
204
No Content
400
application/json
Bad Request
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
401
application/json
Unauthorized
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
403
application/json
Forbidden
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
404
application/json
Not found
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
500
application/json
Internal Server Error
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
503
application/json
Service Unavailable
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/automation-connections/{id}/actions/change-owner" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"userId":"sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"}'
const https = require('https')
const data = JSON.stringify({"userId":"sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/automation-connections/{id}/actions/change-owner',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
{
"userId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"
}
Changes the space of an automation connection by specifying a new space.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- idstringRequired
The unique identifier for the automation connection.
Request Body
Requiredapplication/json
The new space of the automation connection.
- application/jsonobject
application/json properties
- spaceIdstring
The unique identifier of the new space.
-
Responses
204
No Content
400
application/json
Bad Request
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
401
application/json
Unauthorized
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
403
application/json
Forbidden
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
404
application/json
Not found
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
500
application/json
Internal Server Error
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
503
application/json
Service Unavailable
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/automation-connections/{id}/actions/change-space" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"spaceId":"5f0f78b239ff4f0001234567"}'
const https = require('https')
const data = JSON.stringify({"spaceId":"5f0f78b239ff4f0001234567"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/automation-connections/{id}/actions/change-space',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
{
"spaceId": "5f0f78b239ff4f0001234567"
}
Tries to validate and checks the connection status of an automation connection.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | managebuild |
Path Parameters
- idstringRequired
The unique identifier for the automation connection.
Responses
200
application/json
OK Response
- application/jsonobject
application/json properties
- isConnectedboolean
The connection status of the automation connection. When true, the automation connection is connected.
-
400
application/json
Bad Request
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
401
application/json
Unauthorized
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
403
application/json
Forbidden
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
404
application/json
Not found
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
500
application/json
Internal Server Error
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
503
application/json
Service Unavailable
- application/jsonobject
application/json properties
- errorsarray of objects
- traceIdstring
A way to trace the source of the error.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/automation-connections/{id}/actions/check" \
-X POST \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/automation-connections/{id}/actions/check',
'method': 'POST',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
This API is not included yet in qlik-cli
Response
{
"isConnected": true
}