# get\_endpoint\_list

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

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

## Syntax

`def get_endpoint_list(` ` self,  ` `server` `)`

## Parameters

Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| server | string | The name of the server on which the endpoints are defined. |

## Return values

AemGetEndpointListResp

Return values

| Value | Type | Description |
| --- | --- | --- |
| endpointList | List<Endpoint> | An array of Endpoint objects. |
| description | string | The endpoint description. |
| isLicensed | bool | Indicates whether the endpoint is licensed on this server. |
| name | string | The endpoint name. |
| role | EndpointRole<br><br>{<br><br>ALL = 0,<br><br>SOURCE = 1,<br><br>TARGET = 2,<br><br>BOTH = 3<br><br>} | The endpoint role: SOURCE or TARGET. |
| type | string | The endpoint type, for example, Oracle. |

## Errors

All of the [general errors](https://help.qlik.com/en-US/enterprise-manager/November2024/Content/EnterpriseManager/EnterpriseManager_APIGuide/NetAPI/error_handling.htm) as well as the errors listed in the table below.

Error responses

| Error | Message | Description |
| --- | --- | --- |
| 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. |