You can use a browser or an HTTP client program to send requests and receive responses.

REST Client Programs

Any client application that can send HTTPS requests is an appropriate tool for developing REST applications with the VMware Aria Operations API. REST client plug-ins are available for most browsers and many IDEs. The following open-source programs are commonly used:

  • cURL. http://curl.haxx.se
  • Postman application. http://www.getpostman.com

In addition, VMware provides language-specific client bindings for the VMware Aria Operations API.

About the Schema Reference

The VMware Aria Operations REST API documentation includes reference material for all elements, types, queries, and operations in the VMware Aria Operations API. It also includes the schema definition files.

Swagger based API documentation is available with the product, with the capability of making REST API calls right from the landing page.

To access the API documentation, use the URL of your VMware Aria Operations cloud proxy. For example, if the URL of your cloud proxy is https://www.cloudproxy.vmware.com, the API reference is available from: https://cloudproxy.vmware.com/suite-api/doc/swagger-ui.html.
Note: You must use your cloud proxy IP or FDQN in the url to access the API documentation.

Language-specific client bindings are available from: 

https://www.cloudproxy.vmware.com/vrops-cloud/suite-api/

Authorize VMware Aria Operations API

To perform API calls, you must authorize your VMware Aria Operations cloud proxy in the Swagger UI using the access token. Enter the CSP Token (apiKey) value and click Authorize.

About the VMware Aria Operations API Examples

All examples include HTTP requests and responses. These examples show the workflow and content associated with operations such as creating and querying for information about objects in your monitored environment.

Example request bodies are in JSON. Request headers required by the VMware Aria Operations API are included in example requests that are not fragments of a larger example.

Most example responses show only those elements and attributes that are relevant to the operation being discussed. Ellipses (...) indicate omitted content within response bodies.