This is an archive version of the document. To get the most up-to-date information, see the current version.

Properties

In this article

    The resources in the /backupServers collection have a number of properties that reflect backup server characteristics. Properties can be used as query parameter values in GET requests.

    Property

    Type

    Description

    id

    integer

    System ID assigned to a backup server in Veeam Availability Console RESTful API.

    name

    string

    Name of a tenant or service provider backup server.

    siteName

    string

    Name of a site.

    serverUid

    string

    System ID assigned to a backup server in Veeam Backup & Replication.

    agentUid

    string

    System ID assigned to a Veeam Cloud Connect agent that is installed on a backup server.

    isCloudConnect

    boolean

    Indicates whether a backup server is a Veeam Cloud Connect server.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property). Can contain links to backup repositories, connected to a backup server, and jobs managed by this server.

    This property can be excluded from the response. For more information, see the SetLinks Custom Query Option (setLinks) section.

    I want to report a typo

    There is a misspelling right here:

     

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