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

(PUT) /backupServers/{ID}

In this article

    Edits settings of a Veeam backup server with the specified ID added to Veeam Backup Enterprise Manager.

    Request

    To edit settings of the Veeam backup server, you need to send the PUT HTTP request to the URL of the /backupServers/{ID} resource.

    HTTP Request

    PUT http://<Enterprise-Manager>:9399/api/backupServers/{ID}

    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. To learn more, see Authentication and Security.

    Request Body

    In the request body, the client must send parameters for the Veeam backup server whose settings must be updated. The body of the request must conform to the XML Schema Definition of Veeam Backup Enterprise Manager RESTful API.

    The request body must contain the following elements:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    Description

    String

    Description of the Veeam backup server added to Veeam Backup Enterprise Manager.

    Yes

    0/1

    DnsNameOrIpAddress

    String

    Full DNS name or IP address of the Veeam backup server added to Veeam Backup Enterprise Manager.

    Yes

    1/1

    Port

    String

    Port over which Veeam Backup Enterprise Manager must communicate with the Veeam backup server.

    Yes

    0/1

    Username

    String

    User name of the account to connect to the Veeam backup server.

    Yes

    0/1

    Password

    String

    Password of the account to connect to the Veeam backup server.

    Yes

    0/1

    For example:

    <?xml version="1.0" encoding="utf-8"?>
    <BackupServerSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <Description/>
     <DnsNameOrIpAddress>srv02.veeam.local</DnsNameOrIpAddress>
     <Port>9392</Port>
     <Username>Administrator</Username>
     <Password>P@ssw0rd</Password>
    </BackupServerSpec>

    Query Parameters

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 204 No Content.

    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: application/xml.

    Response Body

    None.

    Example

    The example below updates the description for the Veeam backup server having ID 6f17f70a-a61c-4ef0-ac7f-426a6ae1ec8b.

    Request:

    PUT https://localhost:9398/api/backupServers/6f17f70a-a61c-4ef0-ac7f-426a6ae1ec8b

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Request Body:

    <?xml version="1.0" encoding="utf-8"?>
    <BackupServerSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <Description>Veeam Backup Server deployed on srv02</Description>
     <DnsNameOrIpAddress>srv02.veeam.local</DnsNameOrIpAddress>
    </BackupServerSpec>

     

    Response:

    204 No Content