Interactive REST API reference

The REST API service provides a comprehensive, intuitive, and interactive real-time reference as a web page. The interactive REST API reference describes each object type, along with the supported operations, request input parameters, response model, and response codes. The REST API reference provides the Try it out! option that enables you to perform REST API operations on a federation. You must log in to use the Try it out! option.

Peer managed federations

To access the interactive REST API reference, obtain the IP address of a Virtual Controller in the federation that you want to manage. Then, in a web browser, navigate to the following URL:

 https://[Virtual Controller IP address]/api/index.html

Centrally-managed federations

To access the interactive REST API reference, obtain the IP address of the Management Virtual Appliance in the federation that you want to manage. Then, in a web browser, navigate to the following URL:

 https://[Management_Virtual_Appliance_IP_address]/api/index.html