This is an archive version of the document. To get the most up-to-date information, see the current version.(POST) /backupServers?action=create
Connects a Veeam backup server to Veeam Backup Enterprise Manager.
Request
To connect a Veeam backup server to Veeam Backup Enterprise Manager, you need to send the POST HTTP request to the URL of the /backupServers?action=create resource.
HTTP Request
POST http://<Enterprise-Manager>:9399/api/backupServers?action=create |
Request Header
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 that you want to connect. 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. | Yes | 1/1 |
DnsNameOrIpAddress | String | DNS name or IP address of the Veeam backup server. | Yes | 1/1 |
Port | String | Port over which Veeam Backup Enterprise Manager must communicate with the Veeam backup server. By default, port 9392 is used. | Yes | 1/1 |
Username | String | User name of the account to connect to the Veeam backup server specified in the DOMAIN\USERNAME or HOST\USERNAME format, for example: 172.16.13.119\Administrator. | Yes | 1/1 |
Password | String | Password of the account to connect to the Veeam backup server. | Yes | 1/1 |
For example:
<?xml version="1.0" encoding="utf-8"?> |
Query Parameters
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 202 Accepted.
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 connects a Veeam backup server having IP address 172.16.13.119 to Veeam Backup Enterprise Manager.
Request: POST http://localhost:9399/api/backupServers?action=create
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Request Body: <?xml version="1.0" encoding="utf-8"?>
Response: 201 Success
Response Body: None |