skip to main content
Hybrid Data Pipeline API reference : Management API : Connector API : Delete a Group
  

Try Now
Delete a Group

Purpose

Delete an On-Premises Connector Group.
The authorized user must be the owner of the On-Premises Connector specified.

URL

https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>

Method

DELETE

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.
<connector-ID> is a unique value associated with the group On-Premises Connector. The value is returned using the <base>/connectors/ GET request. The authorized user must be the owner of the group On-Premises Connector specified.

Response Definition

If the Remove On-Premises Connectors operation requested is successful, the response is a JSON object defined as

{
"success":true
}
If the Remove Group operation is not successful, the response is a standard error response.

Authentication

Basic Authentication using Login ID and Password.

Authorization

Only the owner of the On-Premises Connector can delete the On-Premise Connector Group.