Chapter 5. Entry Point
A user begins interacting with the API through a
GET request on the entry point URI consisting of a host and base.
Example 5.1. Accessing the API Entry Point
If the host is
www.example.com and the base is /api, the entry point appears with the following request:
GET /api HTTP/1.1
Accept: application/xml
Host: www.example.com
Authorization: [base64 encoded credentials]
HTTP/1.1 200 OK
Content-Type: application/xml
<api>
<link href="/api/domains" rel="domains" />
...
<product_info>
<name>Red Hat Storage Console</name>
<vendor>Red Hat</vendor>
<version major="3" minor="0" build="0" revision="0"/>
<full_version>3.0.0-0.10.el6_5</full_version>
</product_info>
<summary>
<hosts>
<total>3</total>
<active>2</active>
</hosts>
<users>
<total>1</total>
<active>1</active>
</users>
</summary>
</api>
Note
For simplicity, all other examples omit the
Host: and Authorization: request headers and assume the base is the default /api path. This base path differs depending on your implementation.
22632%2C+Console+Developer+Guide-322-09-2014+17%3A11%3A35Report a bug
5.1. Product Information
The entry point contains a
product_info element to help an API user determine the legitimacy of the Red Hat Storage environment. This includes the name of the product, the vendor and the version.
Example 5.2. Verify a genuine Red Hat Storage environment
The follow elements identify a genuine Red Hat Storage 3.0 environment:
<api>
...
<product_info>
<name>Red Hat Storage Console</name>
<vendor>Red Hat</vendor>
<version major="3" minor="0" build="0" revision="0"/>
<full_version>3.0.0-0.10.el6_5</full_version>
</product_info>
...
</api>
22632%2C+Console+Developer+Guide-322-09-2014+17%3A11%3A35Report a bug
