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 or SnapCenter Plug-in for VMware vSphere REST APIs, as well as to manually issue an API call. You can use REST APIs to help manage your SnapCenter Server or perform protection operations on VMs and datastores.

Before you begin


  1. From a browser, enter the URL to access the Swagger web page.
    To access these APIs... Use the format...
    SnapCenter Server https://<SnapCenter_IP_address_or_name>:8146/swagger/
    SnapCenter Plug-in for VMware vSphere https://<plug-in_host_IP_address_or_domain_name>:8144/api/swagger-ui.html#
    Note: Ensure that the REST API URL does not have the following characters: +, ., %, and &.
    Access SnapCenter Server REST APIs:
    Access SnapCenter Plug-in for VMware vSphere REST APIs:

    Log ins use the vCenter authentication mechanism to generate the token.

  2. For SnapCenter Server REST APIs only: 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 or https://<vCenter_host_IP_address>:8146/Content/swagger/SnapCenter.yaml, and click Explore.
    Note: For SnapCenter Plug-in for VMware vSphere REST APIs, all documentation is on the Swagger page.
    A list of API resource types, or categories, is displayed.
  3. Click an API resource type to display the APIs in that resource type.