Skip to main content Skip to complementary content

GetEndpointList

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

Required User Role: See Required Enterprise Manager permissions.

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

{

ALL = 0,

SOURCE = 1,

TARGET = 2,

BOTH = 3

}

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.

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!