Accessing REST APIs using the Swagger API web page

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

Before you begin

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

Steps

  1. From a browser, using the SnapCenter Server management IP address or domain name, enter the URL to access the Swagger web page with the format https://<SnapCenter_IP_address_or_name>:8146/swagger/.
    Example
    https://10.63.65.121:8146/swagger/
  2. If the Swagger API documentation does not display automatically, in the Swagger Explore field, type the URL to the location of the Swagger documentation: https://<SnapCenter_IP_address_or_name>:8146/Content/swagger/SnapCenter.yaml, and click Explore.
    A list of API resource types, or categories, is displayed.
  3. Click an API resource type to display the APIs in that resource type.