Skip to main content
SnapCenter Software 5.0

How to access REST APIs using the Swagger API web page

Contributors netapp-nsriram
PDFs

REST APIs are exposed through the Swagger web page. You can access the Swagger web page to display the SnapCenter Server REST APIs, as well as to manually issue an API call. You can use REST APIs to help manage your SnapCenter Server or to perform data protection operations.

You should know the management IP address or domain name of the SnapCenter Server on which you want to execute the REST APIs.

You do not need special permissions to run the REST API client. Any user can access the Swagger web page. The respective permissions on the objects that are accessed via the REST API are based on the user who generates the token to login to the REST API.

Steps

  1. From a browser, enter the URL to access the Swagger web page in the format https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/swagger/.

    Note Ensure that the REST API URL does not have the following characters: +, ., %, and &.

  2. In the Swagger Explore field, if the Swagger API documentation does not display automatically, type: https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/Content/swagger/SnapCenter.yaml

  3. Click Explore.

    A list of API resource types or categories are displayed.

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

If you encounter unexpected behavior when executing SnapCenter REST APIs, you can use the log files to identify the cause and resolve the problem. You can download the log files from the SnapCenter user interface by clicking Monitor > Logs > Download.