DeleteEndpoint
Description
Deletes the specified endpoint. Note that an endpoint can only be deleted if it is not in use by any task.
Required User Role: See Required Enterprise Manager permissions.
Syntax
public void DeleteEndpoint(
string server,
string endpoint
);
Parameters
| Parameter | Type | Description |
|---|---|---|
| server | - | The server where the endpoint is defined. |
| endpoint | - | The name of the endpoint to be deleted. |
Return values
N/A
Errors
| Error | Message | Description |
|---|---|---|
|
AEM_ENDPOINT_NOT_FOUND |
Replicate endpoint {endpoint} on server {server} could not be found. | Endpoint name unknown to Qlik Enterprise Manager. |
|
AEM_DELETE_ENDPOINT_INNER_ERR |
Failed to delete Replicate endpoint {endpoint} from server {server}. |
Replicate encountered an error/exception when trying to delete the endpoint. |
|
AEM_ENDPOINT_IS_IN_USE |
Replicate endpoint {endpoint} on server {server} cannot be deleted as it is currently in use by one or more tasks. |
The Replicate endpoint must be removed from its associated tasks before it can be deleted. |