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.

The following operations can be performed with the Connector API.

Operation Request URL
Retrieve a list of On-Premises Connectors owned by or shared with the authenticated user GET https://<myserver>:<port>/api/mgmt/connectors
Retrieve the On-Premises Connector's information GET https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>
Update the connector information PUT https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>
Retrieve authorized users for a particular connector GET https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/authuser
Add authorized users to a connector’s access control list. POST https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/authuser
Update the list of authorized users for a connector PUT https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/authuser
Delete authorized users and groups from a connector’s access control list

Deprecated

 DELETE https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/authuser
Create a Connector group to enable failover to member Connectors POST https://<myserver>:<port>/api/mgmt/connectors
Add members to a Connector group POST https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/members
Retrieve the list of members for a Connector group GET https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/members
Define how round-robin load balancing is implemented in a Group Connector PUT https://<myserver>:<port>/api/mgmt/connectors/<group-connector>
Replace the list of On-Premises Connectors in a Connector group PUT https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/members
Remove an On-Premises Connector from an On-Premise Connector Group

Deprecated

 DELETE https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>/members
Delete a group DELETE https://<myserver>:<port>/api/mgmt/connectors/<connector-ID>