Skip to main content Skip to complementary content

GetServerList

General

URL

https://[host]/attunityenterprisemanager/api/v1/servers

Description

Retrieves a list of servers under Qlik Enterprise Manager management as well as each server's properties.

HTTP method

GET

Required user role

See Required Enterprise Manager permissions.

Request parameters

Request parameters
Location Name Required Example

URL

host [string]

Yes

computer.network.net

Header

EnterpriseManager.APISessionID [string]

Yes

wCo0_KvjEUFROvfHF5KGrw

Response body

{

"serverList": [{

"$type": "{string}",

"name": "{string}",

"description": "{string}",

"host": "{string}",

"port": "{string}",

"state": "{enum_server_state}",

"message": "{string}",

"platform": "{enum_server_platform}",

"version": "{string}",

"last_connection":"{string}"

}, …

]

}

Response parameters

Response parameters
Name Description

$type

The server's type, which can either be ReplicateServerInfo or ComposeServerInfo.

name The name of the server.
description The description of the server.
host The host name or IP address of the server.
port The port through which the server is accessed.
state The current state of the server.
message The error message if Qlik Enterprise Manager fails to connect and monitor the server.
platform The operating system on which the server is installed.
version The version of the server.
last_connection The date and time of the last successful sync/retrieval of tasks and messages.

cURL example

Request

CURL.EXE -i -k --header "EnterpriseManager.APISessionID: wCo0_KvjEUFROvfHF5KGr https://computer.network.net/attunityenterprisemanager/
api/v1/servers

Response

Headers:

HTTP/1.1 200 OK

Cache-Control: no-cache, no-store

Content-Length: 1658

Content-Type: application/json; charset=utf-8

Server: Microsoft-HTTPAPI/2.0

Date: Mon, 26 Dec 2016 13:18:27 GMT

Payload

{

"serverList": [{

"$type": "ReplicateServerInfo",

"name": "RepBS",

"description": "replicate for business",

"host": "rep2008r2gs7.qa.int",

"port": "443",

"state": "MONITORED",

"message": "",

"platform": "WINDOWS",

"version": "5.2.0.156",

"last_connection": "2016-12-18T02:23:30",

}, {

"$type": "ReplicateServerInfo",

"name": "RepDev",

"description": "replicate for developers",

"host": "rep2008r2gs8.qa.int",

"port": "443",

"state": "NOT_MONITORED",

"message": "Server changed status to Not Monitored.",

"platform": "WINDOWS",

"version": "5.2.0.156",

"last_connection": "2016-11-16T05:30:00",

}, {

"$type": "ReplicateServerInfo",

"name": "RepProd",

"description": "replicate for production",

"host": "rep2008r2gs9.qa.int",

"port": "443",

"state": "ERROR",

"message": "REPLICATE-E-REPSRVNFND, Replicate server 'Rep 5003' not found. Last Connection: 12:21 PM",

"platform": "WINDOWS",

"version": "5.2.0.156",

"last_connection": "2016-11-16T05:30:00",

}

]

}

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!