Resource URLs

In this article

    Each Veeam Service Provider Console REST API-exposed entity has a resource representing it. To get a resource representation, request its URL. All Veeam Service Provider Console REST API URLs have the following base:

    where:

    • <hostname> is the DNS name or IP address of the machine on which Veeam Service Provider Console Web UI is installed.
    • <port> is the REST API v3 port number you specified during Veeam Service Provider Console Web UI installation.

    The default port number is 1280.

    To get a collection of the Veeam Service Provider Console REST API resources, request a base URL followed by resource collection path. For example:

    GET https://localhost:1280/api/v3/infrastructure/backupServers

    To get a representation of an individual resource, enter a resource identifier after a resource collection path. For example:

    GET https://localhost:1280/api/v3/infrastructure/backupServers/c3517470-112c-11ea-aaef-0800200c9a66

    The resource identifier is represented by the instanceUid properties of the resource from the collection.

    {

       "meta": {

           "pagingInfo": {

               "total": 3,

               "count": 3,

               "skip": 0

           }

       },

       "data": [

           {

               "instanceUid": "c3517470-112c-11ea-aaef-0800200c9a66",

               "name": "bckp2",

               "locationUid": "140b6824-5b8c-437f-a2b9-1bf6dc4a9790",

               "managementAgentUid": "a07794fe-3585-4388-9c75-2f960c19197d",

               "version": "11.0.0.837",

               "displayVersion": "11.0.0.837",

               "installationUid": "9b45a1fa-8bfb-4f23-890d-aa56408faf73",

               "backupServerRoleType": "cloudConnect",

               "status": "healthy"

           },

           {

               "instanceUid": "38110067-0c67-462b-9dfa-656bc08cd3b3",

               "name": "bckp3",

               "locationUid": "140b6824-5b8c-437f-a2b9-1bf6dc4a9790",

               "managementAgentUid": "5c50d211-791b-4940-b547-db740e96b7a0",

               "version": "11.0.0.837",

               "displayVersion": "11.0.0.837",

               "installationUid": "889e15e0-bfb7-4804-ab0e-5a97279d8fde",

               "backupServerRoleType": "cloudConnect",

               "status": "healthy"

           },

           {

               "instanceUid": "450e2a1b-f4a7-4ebc-b246-c32413fa15b2",

               "name": "bckp6",

               "locationUid": "3f5938c4-12c5-45a4-a1a5-c158d5848238",

               "managementAgentUid": "eb4c38b4-8569-4d51-91d2-00ba90c06ccc",

               "version": "11.0.0.837",

               "displayVersion": "11.0.0.837",

               "installationUid": "49ce8088-aba6-403c-bd7d-1d734472e50a",

               "backupServerRoleType": "client",

               "status": "healthy"

           }

       ]

    }