skip to main content
Hybrid Data Pipeline API reference
  

Try Now

Hybrid Data Pipeline API reference

Hybrid Data Pipeline provides a representational state transfer (REST) application programming interface (API) for managing Hybrid Data Pipeline connectivity service resources.
Hybrid Data Pipeline APIs use HTTP Basic Authentication to authenticate user accounts. The Hybrid Data Pipeline user ID and password are encoded in the Authorization header. The Hybrid Data Pipeline user specified in the Authorization header is the authenticated user.
Note: Administrators can execute a number of API operations on behalf of standard Hybrid Data Pipeline users. For details, see Managing resources on behalf of users and User provisioning.
To execute REST calls, you must pass a valid REST URL and pass a valid username and password to authenticate with basic authentication. A REST URL must include a base and resource-specific information. The base includes the Web protocol, a server name, and a port number, while resource-specific information provides a path to a particular resource necessary for performing an API operation. For example:
https://MyServer:8443/api/mgmt/datasources
Note: The port number is only required if the Hybrid Data Pipeline server or load balancer is configured to use a port other than 443 for SSL or 80 for non-SSL connections.
The syntax for a REST URL can be described as follows.
webprotocol://servername:portnumber/resourceinfo
where
webprotocol
is the Web protocol, such as HTTP or HTTPS, used to connect to your Hybrid Data Pipeline instance.
servername
is the name of the machine hosting the Hybrid Data Pipeline service, or the name of the machine hosting the load balancer used to route requests to the Hybrid Data Pipeline service.
portnumber
is the port number of the machine hosting the Hybrid Data Pipeline service, or the port number of the machine hosting the load balancer used to route requests to the Hybrid Data Pipeline service. For a standalone installation, the port number is specified as the Server Access Port during installation. For a load balancer installation, the port number must be either 80 for http or 443 for https. Whenever port 80 or 433 are used, it is not necessary to include the port number in the URL.
resourceinfo
is resource-specific information that provides a path to a particular Hybrid Data Pipeline resource necessary to perform an API operation.

Compatibility Note

Future versions of Hybrid Data Pipeline APIs may add additional properties, arrays or objects to response payloads. To ensure maximum compatibility with future versions, calling applications should be coded to ignore elements that they do not recognize.
For example, suppose an application contains an endpoint foo that returns a response that looks like the following code snippet:
{
"accountName":"test",
"type":"individual",
"status":"active"
}
At a later time, the response is modified to add creationDate and lastModifiedDate.
{
"accountName":"test",
"type":"individual",
"status":"active",
"creationDate":"2015-01-01 01:01:01",
"lastModifiedDate":"2005-02-24 02:02:02"
}
Code to parse the response that was written to look for the original accountName, type, and status properties, will continue to work with the new response. However, the applications just would not take advantage of the new information.
* Administrators API
* Health Check API
* IP Address Whitelist API
* Management API
* Password Policy API
* Hybrid Data Pipeline API Error Messages