How to access REST APIs using the Swagger API web page
PDF of this doc site
- SnapCenter Server installation
Protect Microsoft SQL Server databases
- SnapCenter Plug-in for Microsoft SQL Server
- Prepare to install the SnapCenter Plug-in for Microsoft SQL Server
Protect SAP HANA databases
- SnapCenter Plug-in for SAP HANA Databases
- Prepare to install the SnapCenter Plug-in for SAP HANA Database
- Back up SAP HANA resources
- Protect Oracle databases
- Protect Windows file systems
- Protect Microsoft Exchange Server databases
Protect Custom applications
- Prepare to install SnapCenter Custom Plug-ins
REST APIs are exposed through the Swagger web page. You can access the Swagger web page to display the SnapCenter Server REST APIs, as well as to manually issue an API call. You can use REST APIs to help manage your SnapCenter Server or to perform data protection operations.
You should know the management IP address or domain name of the SnapCenter Server on which you want to execute the REST APIs.
You do not need special permissions to run the REST API client. Any user can access the Swagger web page. The respective permissions on the objects that are accessed via the REST API are based on the user who generates the token to login to the REST API.
From a browser, enter the URL to access the Swagger web page in the format https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/swagger/.
Ensure that the REST API URL does not have the following characters: +, ., %, and &.
In the Swagger Explore field, if the Swagger API documentation does not display automatically, type: https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/Content/swagger/SnapCenter.yaml
A list of API resource types or categories are displayed.
Click an API resource type to display the APIs in that resource type.
If you encounter unexpected behavior when executing SnapCenter REST APIs, you can use the log files to identify the cause and resolve the problem. You can download the log files from the SnapCenter user interface by clicking Monitor > Logs > Download.