You can also use REST tools such as Postman to browse the HPE OneSphere REST API and place REST calls to the API.

A REST API has a number of design principles:

It uses HTTP and HTTPS as a communication protocol

It uses a very simple set of HTTP verbs to initiate actions (PUT, GET, POST, DELETE, and PATCH)

Objects are represented by their URI (Universal Resource Identifier)

Any REST call is in the form of:

Verb protocol://server-end-point/URI

Where Verb can be one of the following, and its action is applied to the provided URI, over the specified protocol at a given server endpoint:

GET: to read the value of a resource

PUT: to change the value of a resource

POST: to create a new instance of a resource

DELETE: to remove an instance of a resource

PATCH: To change a subset of the properties of a resource

For example, the following REST call retrieves the list of providers:

GET https://{YourHPEOneSpherePortalURL}/rest/providers

Accessing the HPE OneSphere REST API interactive documentation

Use the following procedure to access the HPE OneSphere REST API from the HPE OneSphere managed service UI. You can perform API operations from this API instance, which is installed in your managed service account.

HPE OneSphere provides API documentation using Swagger (https://swagger.io). Swagger uses HTML to present the API calls that can be used, together with the parameters that need to be provided and the expected status code and response.