Skip to main content
OnCommand Unified Manager 9.5
A newer release of this product is available.

Accessing REST APIs using the Swagger API web page

Contributors netapp-adityaw
PDFs

REST APIs are exposed through the Swagger web page. You can access the Swagger web page to display the Unified Manager REST API documentation, as well as to manually issue an API call.

Before you begin

  • You must have one of the following roles: Operator, Storage Administrator, or OnCommand Administrator.

  • You must know the IP address or fully qualified domain name of the Unified Manager server on which you want to execute the REST APIs.

About this task

An example is provided for each REST API in the Swagger web page to help explain the objects and attributes you can use to return the information you are interested in reviewing.

Steps

  1. Access the Unified Manager REST APIs.

    Option Description

    From the Unified Manager web UI:

    From the Menu Bar, click the Help button and then select API Documentation.

    From the browser window:

    Using the Unified Manager server IP address or FQDN, enter the URL to access the REST API page in the format https://<Unified_Manager_IP_address_or_name>/apidocs/. For example, https://10.10.10.10/apidocs/

    A list of API resource types, or categories, is displayed.

  2. Click an API resource type to display the APIs in that resource type.