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

Try Now

Connector API

The Connector API can be used to manage access to backend data through On-Premises Connectors. An On-Premises Connector is, by default, only accessible to its owner, the user who installed and registered the connector. The owner may share backend data by authorizing other Hybrid Data Pipeline users to use an On-Premises Connector. The owner manages a list of users that can use the connector by executing GET, POST, PUT, and DELETE operations with the Connector API.
In addition, the Connector API allows users to manage requests among multiple On-Premises Connectors by creating On-Premises Connector groups. See the following topics for details.
*Using Failover and Balancing Requests with an On-Premises Connector Group
*Configuring Failover and Balancing Requests with an On-Premises Connector Group
The following operations can be performed with the Connector API.
Operation
Request
URL
GET
https://<myserver>:<port>/api/mgmt/connectors
GET
https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>
PUT
https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>
GET
https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/authuser
POST
https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/authuser
PUT
https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/authuser
Deprecated
DELETE
https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/authuser
POST
https://<myserver>:<port>/api/mgmt/connectors
POST
https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/members
GET
https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/members
PUT
https://<myserver>:<port>/api/mgmt/connectors/<group-connector>
PUT
https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/members
Deprecated
DELETE
https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/members
DELETE
https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>
* Using Failover and Balancing Requests with an On-Premises Connector Group
* Configuring Failover and Balancing Requests with an On-Premises Connector Group
* Get Connectors
* Get Connector Information
* Update Connector Information
* Get Authorized Users
* Add Authorized Users
* Update Authorized Users
* Delete Authorized Users
* Create a Connector Group
* Add On-Premises Connectors to an On-Premises Connector Group
* Get the List of On-Premises Connectors in an On-Premises Connector Group
* Configure Round-Robin Request Balancing for an On-Premises Connector Group
* Replace the List of On-Premises Connectors in an On-Premises Connector Group
* Remove an On-Premises Connector
* Delete a Group