DeleteEndpoint
General
URL
https://[host]/attunityenterprisemanager/api/v1/servers/[server]/endpoints/[endpoint]?action=delete
Description
Deletes the specified endpoint. Note than an endpoint can only be deleted if it is not in use by any task.
HTTP method
DELETE
Required user role
See Required Enterprise Manager permissions.
Request parameters
| Location | Name | Required | Example |
|---|---|---|---|
|
URL |
host [string] |
Yes |
computer.network.net |
|
URL |
ServerName [string] |
Yes |
myrepsrv1 |
|
URL |
EndpointName [string] |
Yes |
Shopping |
| Header |
EnterpriseManager.APISessionID [string] |
Yes |
wCo0_KvjEUFROvfHF5KGrw |
|
Header |
Content-Length |
Yes |
Content-Length: 0 Note that the Content-Length value must be "0". |
cURL example
Request
curl -i -k -X POST --header "EnterpriseManager.APISessionID: wCo0_KvjEUFROvfHF5KGrw" --header "Content-Length: 0"
https://computer.network.net/attunityenterprisemanager/api/v1/
servers/myrepsrv1/endpoints/Shopping?action=delete
Response
Header: HTTP/1.1 200 OK Cache-Control: no-cache, no-store Content-Length: 38 Content-Type: application/json; charset=utf-8 Server: Microsoft-HTTPAPI/2.0 Date: Mon, 26 Dec 2016 16:31:01 GMT
Error response
| HTTP Code | Enterprise Manager Code | Text | Description |
|---|---|---|---|
|
500 |
AEM_ENDPOINT_NOT_FOUND |
Replicate endpoint {endpoint} on server {server} could not be found. | Endpoint name unknown to Qlik Enterprise Manager. |
|
500 |
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. |
|
500 |
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. |
|
403 |
See Error handling. |
- |
- |
|
440 |
See Error handling. |
- |
- |