skip to main content
DataDirect Cloud Connector API : Getting Started with the DataDirect Cloud Connector API
 

Try DataDirect Cloud Now

Getting Started with the DataDirect Cloud Connector API

To access the API, you must have a valid DataDirect Cloud account (see Setting Up a DataDirect Cloud Account).
The Connector API uses HTTP Basic Authentication to authenticate the user. The DataDirect Cloud user ID and password are encoded in the Authorization header, and are always transferred encrypted. All requests to the API use HTTPS.
The DataDirect Cloud user is the authenticated user. An authorized user is granted permission by the authenticated user to access the authenticated user’s On-Premise Connectors.
For more information about how Progress Partners access and use APIs, watch a video.
For more information about getting started with the Progress Partner distribution service, watch a video.
Using the Connector API, you can perform the operations described in the following table.
Operation
Request
URL
GET
https://service.datadirectcloud.com/api/mgmt/connectors
Retrieve the On-Premise Connector's information: the Connector ID, owner, and the list of authorized users who have been granted permission to use this connector.
GET
https://service.datadirectcloud.com/api/mgmt/connectors/<connector-ID>
PUT
https://service.datadirectcloud.com/api/mgmt/connectors/<connector-ID>
Retrieve authorized users for a particular connector. If the Connector ID is a group, also contains the group details, such as members, retryDelay, and connectionTimeout.
GET
https://service.datadirectcloud.com/api/mgmt/connectors/<connector-ID>/authuser
POST
https://service.datadirectcloud.com/api/mgmt/connectors/<connector-ID>/authuser
PUT
https://service.datadirectcloud.com/api/mgmt/connectors/<connector-ID>/authuser
Deprecated
DELETE
https://service.datadirectcloud.com/api/mgmt/connectors/<connector-ID>/authuser
POST
https://service.datadirectcloud.com/api/mgmt/connectors
POST
https://service.datadirectcloud.com/api/mgmt/connectors/<connector-ID>/members
GET
https://service.datadirectcloud.com/api/mgmt/connectors/<connector-ID>/members
PUT
https://service.datadirectcloud.com/api/mgmt/members
Replace the list of On-Premise Connectors in a Connector group. One member must be retained in the group.
PUT
https://service.datadirectcloud.com/api/mgmt/connectors/<connector-ID>/members
PUT
https://service.datadirectcloud.com/api/mgmt/connectors/<group-connector>
Deprecated
DELETE
https://service.datadirectcloud.com/api/mgmt/connectors/<connector-ID>/members
DELETE
https://service.datadirectcloud.com/api/mgmt/connectors/<connector-ID>
* Using Failover and Load Balancing with an On-Premise Connector Group
* Enabling Failover and Load Balancing with an On-Premise Connector Group