Evaluation with Swagger UI

In this article

    To start working with the Veeam Service Provider Console REST API, you can use any client application that supports the HTTPS protocol.

    Evaluation with Swagger UI Tip:

    You can generate your own client using Swagger Generator. For more information, see Online Generators.

    The Veeam Service Provider Console REST API is additionally available through Swagger UI, a tool that you can use to evaluate and explore capabilities of the Veeam Service Provider Console REST API. Swagger UI visually presents API specification files and allows you to work with resources.

    All resources and methods are expandable. When you expand a method, you get a full description of available parameters and an automatically generated example. You can also send requests and see response messages.

    To access Swagger UI for the Veeam Service Provider Console REST API:

    1. In the Internet browser address bar, enter the Veeam Service Provider Console REST API URL in the following format: https://<hostname>:<port>/api.
    2. On the landing page, click SwaggerUI.

    Alternatively, in the Internet browser address bar, you can enter the Veeam Service Provider Console REST API URL in the following format: https://<hostname>:<port>/api/swagger.

    By default, all resources are visible. To view only those resources that are available to users with a specific user role, open a drop down list in the upper right corner of the window and select the role.

    To download the REST API specification with role specific resources, select the role and click the link under the VSPC REST header.

    In This Section