GET /backupServers/{ID}

In this article

    Returns a resource representation of the backup server having the specified ID.

    Request

    To get a resource representation of the backup server, send the GET HTTP request to the URL of the /backupServers/{ID} resource:

    HTTP Request

    GET https://<Enterprise-Manager>:9398/api/backupservers/{ID}

    or

    GET https://<Enterprise-Manager>:9398/api/backupServers/{ID}?format=Entity

    Request Headers

    The request contains the following headers:

    Header

    Required

    Description

    X-RestSvcSessionId

    True

    The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security.

    Accept

    False

    Identifies the format of the response. Possible values:

    • application/xml — the client can send this value in the header to accept response in the XML format.
    • application/json — the client must send this value in the header to accept the request in the JSON format.

    If the request does not contain the header, the server will return the response in the XML format.

    Request Body

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTP headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the request body message. Possible values:

    • application/xml
    • application/json

    Response Body

    In the response body, Veeam Backup Enterprise Manager returns an entity or an entity reference of the /backupServers/{ID} resource. The resource entity contains the following parameters and links.

    Parameters

    Element

    Type

    Description

    UID

    UidType

    UID of the backup server connected to Veeam Backup Enterprise Manager, for example: urn:veeam:BackupServer:15942270-fb56-4dcc-96e9-5f80e4725a15.

    Name

    String

    Name of the backup server connected to Veeam Backup Enterprise Manager, for example: Backup Server 1.

    Description

    String

    Description specified for the backup server in Veeam Backup Enterprise Manager.

    Port

    Int64

    Port used by Veeam Backup Enterprise Manager for collecting data from backup servers. By default, port 9392 is used.

    Version

    String

    Version of Veeam Backup & Replication installed on the backup server, for example: 11.0.1.1261.

    To view query parameters that you can use for filtering or sorting, see GET /query?type=BackupServer.

    Links

    Reference

    Relationship

    Description

    /backupServers/{ID}

    Alternate

    Alternate URL of the /backupServers/{ID} resource.

    /backupServers/{ID}

    Edit

    URL for the PUT /backupServers/{ID} request.

    /backupServers/{ID}

    Delete

    URL for the DELETE /backupServers/{ID} request.

    /backupServers/{ID}/jobs

    Down

    URL of the /jobs resource — a collection of jobs configured on the backup server.

    /backupServers/{ID}/managedServers

    Down

    URL of the /managedServers resource — a collection of managed servers added to the backup server infrastructure.

    /backupServers/{ID}/repositories

    Down

    URL of the /repositories resource — a collection of repositories configured on the backup server.

    /backupServers/{ID}/externalRepositories

    Down

    URL of the /externalRepositories resource — a collection of external repositories configured on the backup server.

    /backupServers/{ID}/credentials

    Down

    URL of the /backupServers/{ID}/credentials resource — a collection of credentials created on the backup server.

    /backupServers/{ID}/credentials?action=create

    Create

    URL for the POST /backupServers/{ID}/credentials?action=create request.

    /backupServers/{ID}/passwords

    Down

    URL of the /backupServers/{ID}/passwords resource — a collection of passwords created on the backup server.

    /backupServers/{ID}/passwords?action=create

    Create

    URL for the POST /backupServers/{ID}/passwords?action=create request.

    /backupServers/{ID}?action=veeamzip

    VeeamZip

    URL for the POST /backupServers/{ID}?action=veeamzip request.

    /backupServers/{ID}?action=quickbackup

    QuickBackup

    URL for the POST /backupServers/{ID}?action=quickbackup request.

    /backupServers/{ID}?action=collect

    Start

    URL for the POST /backupServers/{ID}?action=collect request.

    Example

    The example below returns an entity representation of the backup server having ID a490c017-2c1c-40ee-8bcf-73bcce6ab36f.

    Request:

    GET https://localhost:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f?format=Entity

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <?xml version="1.0" encoding="utf-8"?>
    <BackupServer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f?format=Entity" Type="BackupServer" Name="enterprise01.tech.local" UID="urn:veeam:BackupServer:a490c017-2c1c-40ee-8bcf-73bcce6ab36f" xmlns="http://www.veeam.com/ent/v1.0">
       <Links>
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f" Name="enterprise01.tech.local" Type="BackupServerReference" Rel="Alternate" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f" Type="BackupServerReference" Rel="Edit" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f" Type="BackupServerReference" Rel="Delete" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f/jobs" Type="JobReferenceList" Rel="Down" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f/managedServers" Type="ManagedServerReferenceList" Rel="Down" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f/repositories" Type="RepositoryReferenceList" Rel="Down" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f/externalRepositories" Type="ExternalRepositoryReferenceList" Rel="Down" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f/credentials" Type="CredentialsList" Rel="Down" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f/credentials?action=create" Rel="Create" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f/passwords" Type="PasswordKeyList" Rel="Down" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f/passwords?action=create" Rel="Create" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f?action=veeamzip" Rel="VeeamZip" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f?action=quickbackup" Rel="QuickBackup" />
           <Link Href="https://enterprise04.tech.local:9398/api/backupServers/a490c017-2c1c-40ee-8bcf-73bcce6ab36f?action=collect" Rel="Start" />
       </Links>
       <Description />
       <Port>9392</Port>
       <Version>11.0.1.1261</Version>
    </BackupServer>