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:

    • <Availability-Console> 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 port number you specified during Veeam Service Provider Console Web UI installation.

    The default port number is 1281.

    • <version> is an API version.

    Current version is v2.

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

    https://vspc:1281/v2/backupServers

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

    https://vspc:1281/v2/backupServers/2

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

    [

     {

       "id": 1,

       "name": "bckp2",

       "siteName": "bckpSite1",

       "serverUid": "ac5eba33-d864-406e-84e9-ad88cca46407",

       "agentUid": "8fd50ad6-3833-4c19-9853-d10a199f82b2",

       "isCloudConnect": true,

       "_links": {

         "self": {

           "href": "https://xag43:1281/v2/backupServers/1"

         },

         "backupRepositories": [],

         "jobs": []

       }

     },

     {

       "id": 2,

       "name": "bckp4",

       "siteName": "bckpSite2",

       "serverUid": "6a25d1aa-e211-468d-ad34-86dd140f1999",

       "agentUid": "31c9f862-f03b-44cf-8789-806a01370947",

       "isCloudConnect": true,

       "_links": {

         "self": {

           "href": "https://xag43:1281/v2/backupServers/2"

         },

         "backupRepositories": [],

         "jobs": []

       }

     }

    ]

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.