# GetEndpointList

## General

### URL

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

Description

Retrieves a list of endpoints and their properties for the specified server.

### Method

GET

### Required user role

See [Required Enterprise Manager permissions](https://help.qlik.com/en-US/enterprise-manager/May2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Introduction/AEMPermissions.htm).

## Request parameters

Request parameters

| Location | Name | Required | Example |
| --- | --- | --- | --- |
| URL | host [string] | Yes | computer.network.net |
| URL | ServerName [string] | Yes | myrepsrv1 |
| Header | EnterpriseManager.APISessionID [string] | Yes | wCo0\_KvjEUFROvfHF5KGrw |

## Response body

`{`

`"endpointList": [{`

`"name": "{string}",`

`"description": "{string}",`

`"role": "{enum endpoint_role}",`

`"type": "{string}",`

`"is_licensed": "{bool}"`

`},...`

`]`

`}`

## Response parameters

Response parameters

| Name | Description |
| --- | --- |
| name | The endpoint name. |
| description | The endpoint description. |
| [role](https://help.qlik.com/en-US/enterprise-manager/May2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm#endpoint_role) | The endpoint role: SOURCE or TARGET |
| type | The endpoint type - for example, Oracle. |
| is\_licensed | Indicates whether the endpoint is licensed on this server. |

## cURL example

### Request

`curl -i -k --header "EnterpriseManager.APISessionID: wCo0_KvjEUFROvfHF5KGrw" https://computer.network.net/attunityenterprisemanager/api/v1/servers/myrepsrv1/endpoints`

### Response

`Headers:`

`HTTP/1.1 200 OK`

`Cache-Control: no-cache, no-store`

`Content-Length: 205`

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

`Server: Microsoft-HTTPAPI/2.0`

`Date: Mon, 26 Dec 2016 11:18:53 GMT`

### Payload

`{`

`"endpointList": [{`

`"name": "Shopping",`

`"description": "Customers and purchases",`

`"role": "SOURCE"`

`"type": "ORACLE"`

`"is_licensed": true`

`}, {`

`"name": "Management",`

`"description": "Managers and Employees",`

`"role": "SOURCE"`

`"type": "ORACLE"`

`"is_licensed": true`

`}, {`

`"name": "Business Management",`

`"description": "Shopping + Management",`

`"role": "TARGET"`

`"type": "HADOOP"`

`"is_licensed": true`

`}`

`]`

`}`

## Error response

Error responses

| HTTP Code | Enterprise Manager Code | Text | Description |
| --- | --- | --- | --- |
| 500 | AEM\_ENDPOINT\_LIST\_INNER\_ERR | Failed to retrieve endpoints list from Replicate server {name}. | Replicate experienced an error/exception when trying to retrieve the endpoint list. |
| 403 | See [Error handling](https://help.qlik.com/en-US/enterprise-manager/May2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/CurlAPI/error_handling.htm). | - | - |
| 440 | See [Error handling](https://help.qlik.com/en-US/enterprise-manager/May2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/CurlAPI/error_handling.htm). | - | - |