Access REST APIs using the Swagger API web page

Contributors Download PDF of this 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 SnapCenter Plug-in for VMware vSphere REST APIs to perform protection operations on VMs and datastores.

The plug-in has different Swagger web pages from the Windows SnapCenter Swagger web pages.

Before you begin

For SnapCenter Plug-in for VMware vSphere REST APIs, you must know either the IP address or the host name of the SnapCenter VMware plug-in.

Note The plug-in only supports REST APIs for the purpose of integrating with third party applications and does not support PowerShell cmdlets or a CLI.
Steps
  1. From a browser, enter the URL to access the plug-in Swagger web page:

    Important Do not use the following characters in the REST API URL: +, . , %, and &.
    Example

    Access the SnapCenter VMware plug-in REST APIs:

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

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