Skip to main content
SnapCenter Plug-in for VMware vSphere 5.0
A newer release of this product is available.

Access REST APIs using the Swagger API web page

Contributors
PDFs

REST APIs are exposed through the Swagger web page. You can access the Swagger web page to display either the SnapCenter Server or the SnapCenter Plug-in for VMware vSphere REST APIs, as well as to manually issue an API call. Use the SnapCenter Plug-in for VMware vSphere REST APIs to perform operations on VMs and datastores.

The plug-in has different Swagger web pages from the SnapCenter Server 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:

    https://<SCV_IP>:8144/api/swagger-ui/index.html

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

    Access the SnapCenter VMware plug-in REST APIs:

    https://<SCV_IP>:8144/api/swagger-ui/index.html
    https://OVAhost:8144/api/swagger-ui/index.html

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

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