Hybrid Data Pipeline API reference : Management API : Version Information API

Version Information API

Purpose

Retrieves version information, along with installation type details. The information returned includes the Product version, Data Access Service version and Web Application version.

URL

https://<myserver>:<port>/api/mgmt/version

Method

GET

URL Parameters

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

Sample Server Success Response

{
"InstallType": "Licenced",
"HDPVersion": "4.3.0",
"WAPVersion": "4.3.0",
"DASVersion": "4.3.0"
}

If you are using the evaluation version, the response will specify some additional details.

{
"InstallType": "Evaluation",
"EvalDaysRemaining": 89,
"EvalExpiryDate": "2018-05-06 T0 8:08:29.000Z",
"HDPVersion": "4.3.0",
"WAPVersion": "4.3.0",
"DASVersion": "4.3.0"
}

Sample Server Failure Response

{
"error": {
"code": 222208070,
"message": {
"lang": "en-US",
"value": "Problem getting version information.”
}
}
}

Authentication

Basic Authentication using Login ID and Password

Authorization

Any active Hybrid Data Pipeline user.