# GetEndpointList

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

`public AemGetEndpointListResp GetEndpointList(` `string server` `);`

## Parameters

Parameters

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

## Return values

AemGetEndpointListResp

Return values

| Parameter | 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

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. |