Difference between revisions of "Cloudpulse/APIDocs"

Revision as of 16:03, 6 July 2017

API Documentation

The cloudpulse project has a RESTful Http service called the Openstack Health API. Through this API cloudpulse allows the user to list the cloudpulse tests, create new cloudpulse tests and see the results of the cloudpulse results.
All api calls described In this documentation require keystone authentication. One can use keystone v2 or v3 version for the authentication. The corresponding configuration should be configured properly in the cloudpulse config in order that the cloudpulse can reach the v2 or the v3 keystone API.
The Identity service generates authentication tokens that permits access to the Cloudpulse REST APIs. Clients can obtain this token and the URL endpoints for other service APIs by supplying their valid credentials to the authentication service. Each time one makes a REST API request to Cloudpulse, the authentication token needs to be provided in the X-Auth-Token request header.

@@ Line 2: / Line 2: @@
 The cloudpulse project has a RESTful Http service called the Openstack Health API. Through this API cloudpulse allows the user to list the cloudpulse tests, create new cloudpulse tests and see the results of the cloudpulse results.<br>
-All api calls described In this documentation require keystone authentication. We can use the keystone v2 or v3 version for the authentication. The corresponding configuration should be configured properly in the cloudpulse config in order that the cloudpulse can reach the v2 or the v3 keystone API.<br>
+All api calls described In this documentation require keystone authentication. One can use keystone v2 or v3 version for the authentication. The corresponding configuration should be configured properly in the cloudpulse config in order that the cloudpulse can reach the v2 or the v3 keystone API.<br>
-The Identity service generates authentication tokens that permit access to the Cloudpulse REST APIs. Clients obtain this token and the URL endpoints for other service APIs by supplying their valid credentials to the authentication service. Each time you make a REST API request to Cloudpulse, you supply your authentication token in the X-Auth-Token request header.
+The Identity service generates authentication tokens that permits access to the Cloudpulse REST APIs. Clients can obtain this token and the URL endpoints for other service APIs by supplying their valid credentials to the authentication service. Each time one makes a REST API request to Cloudpulse, the authentication token needs to be provided in the X-Auth-Token request header.