Help Center
Choose product document...
Veeam Backup & Replication 9.5
RESTful API Reference

(POST) /backupServers/{ID}/passwords?action=create

Creates a new password on the Veeam backup server having the specified ID.

Request

To create a new password record on a specific Veeam backup server, you need to send the POST HTTP request to the /backupServers/{ID}/passwords?action=create URL.

HTTP Request

POST http://<Enterprise-Manager>:9399/api/backupServers/{ID}/passwords?action=create

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 a new password that must be created on the Veeam backup server. 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

Hint

String

Hint for the created password.

Yes

0/1

Password

String

Password value.

Yes

1/1

For example:

<?xml version="1.0" encoding="utf-8"?>
<PasswordKeyInfoSpec 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">
 <Hint>My favorite book</Hint>
 <Password>1234</Password>
</PasswordKeyInfoSpec>

Query Parameters

None.

Response

The server returns the following response to the client.

Response Codes

A successfully 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 adds a new password on the Veeam backup server having ID f62624c1-8462-4747-8bd4-d686f99b0540. The password record has the following parameters:

  • Hint: My favorite book
  • Password 1234

Request:

POST http://localhost:9399/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540/passwords?action=create

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Request Body:

<?xml version="1.0" encoding="utf-8"?>
<PasswordKeyInfoSpec 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">
 <Hint>My favorite book</Hint>
 <Password>1234</Password>
</PasswordKeyInfoSpec>

 

Response:

201 Created

 

Response Body:

None

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation