Skip to main content
BlueXP backup and recovery for VMs

Access REST APIs using the Swagger API web page

Contributors netapp-manishc
PDFs

REST APIs are exposed through the Swagger web page. You can access the Swagger web page to display the BlueXP backup and recovery for VMs REST APIs.

Before you begin

For BlueXP backup and recovery for VMs REST APIs, you must know either the IP address or the host name of the BlueXP backup and recovery for VMs appliance.

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://<OVA_IP>/api/swagger-ui/index.html

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

    Example

    Access BlueXP backup and recovery for VMs REST APIs:

    https://<OVA_IP>/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.