REST API Documentation Format

The HyperFlex REST API Explorer provides the necessary documentation and information for all available HyperFlex APIs. Depending on the type of API or specific parameters, the look and feel of the information may slightly vary. The informational sections you may encounter when viewing the API documentation within the HyperFlex REST API Explorer are described in detail here.

Response Class

The Response Class section of the API provides information about a successful response and its format.

Parameters

The Parameters section of the API provides information on what parameters (data) are required for the successful operation of the API. This includes both optional and mandatory parameters. Information about each parameter such as a Description, Parameter Type (query, body), and Data Type (string, JSON object) are detailed in this section.

Response Messages

The Response Messages section of the API provides insight into the various HTTP status code messages and their meaning. The messages provide detailed information on the format of API failure responses. These response messages might be received when an API operation fails.

Try it Out

The Try It Out section of the API is a valuable tool for testing specific API calls against the local HyperFlex cluster. This tool allows you to do the following:

• Try an API operation and view the request code as a Curl request.
• View the Request URL.
• View the Response Body from the API call.

Caution:

The Try It Out feature operates API calls against the local HyperFlex cluster. Be aware of what APIs you are testing as they will be run against the local system.

To use the Try It Out feature, enter the appropriate values in the API Parameters section and then click the Try It Out button. The specific API query is now run against the local HyperFlex cluster and the following information will be displayed:

Curl request code that was executed:

Request URL:

Response Body:

Response Code:

Response Headers: