Purpose

Retrieves the list of On-Premises Connectors that are owned by or shared with the authenticated Hybrid Data Pipeline user.

URL 

https://<myserver>:<port>/api/mgmt/connectors?details=true&accessible=true

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <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.

Query Parameters

Parameter Description Usage Valid Values
details Determines whether the additional details of the Connectors are included in the response. Optional true | false

When set to true, the details of Connectors, such as the owner and authorized users, are included in the response.

When set to false, only the Connector IDs are returned.

The default is false.
accessible Determines whether the response includes all of the Connectors owned by or shared with the user making the request. Optional true | false

When set to true, the response includes all the Connectors accessible (owned and shared) to the user making this request.

When set to false, the response includes only the Connectors owned by this user.

The default is false.

Response Definition

When the query parameters are set to false (the default), only the Connector ID of each Connector owned by the user is returned. The response has the following format:

{
  "connectorIDs": [
      <"connector-id">,
      <"connector-id">,
      ...
      <"connector-id">
   ]
}

where:

connector-id
can reference an individual On-Premises Connector or an On-Premises Connector Group owned by or shared with the authenticated user. If the authenticated user does not own any Connectors and no Connectors have been shared, the array of connector IDs in the response is empty.

When both query parameters are set to true, the Connector IDs and details of each Connector owned by and shared with the user are returned. The response has the following format:

{
  "connectorIDs": [
    {
       "connectorId": <"connector-id">,
       "owner": "ownername1", 
       "label": "Label1",
       "authUser": ["user1", "user2"]
    },
    {
       "connectorId": <"connector-id">,
       "owner": "ownername1", 
       "label": "Label2",
       "authUser": ["user1", "user2"]
    },
        ...
    {
       "connectorId": <"connector-id">,
       "owner": "ownername1", 
       "label": "Label3",
       "authUser": ["user3", "user4"]
     }
   ]
}

Sample Server Response

In this example, details and accessible were set to true. The first Connector lists three authorized users, indicating that the user is the owner of the Connector. Note that the second Connector has a different owner, and therefore, has an empty list of authorized users.

{
  "connectorIds": [
    {
     "connectorId": "55b55556-22d1-4f6a-888f-444a2df565e0",
     "owner": "ddctest01",
     "label": "DevTest1",
     "authUser": [
       "Joe",
       "Fred",
       "Tom"
     ]
   },
   {
     "connectorId": "7e7afa77-5555-44c3-b0ff-6bbe888edf8a",
     "owner": "ddctest02",
     "label": "DevTest1",
     "authUser": []
   }
  ]
}

Also notice that because the Connectors have the same label, the owner's name will be attached to the label of the second Connector when displayed in the data source setup screen.

Authentication

Basic Authentication using Login ID and Password.

Authorization

Any active Hybrid Data Pipeline user