Veeam Backup & Replication 10
Veeam RESTful API Reference
Related documents

(PUT) /backupServers/{ID}/passwords/{ID}

Edits parameters for a password having the specified ID on the Veeam backup server with the specified ID.

Request

To edit parameters for the password, you need to send the PUT HTTP request to the URL of the /backupServers/{ID}/passwords/{ID} resource.

HTTP Request

PUT https://<Enterprise-Manager>:9398/api/backupServers/{ID}/passwords/{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.

Content-Type

True

Identifies the format of the request body message. Possible values:

  • application/xml
  • application/json

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

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

(PUT) /backupServers/{ID}/passwords/{ID}Note:

Currently, the only parameter that can be edited for the password is the Hint parameter.

The request body must contain the following elements:

Element

Type

Description

Modifiable

Min/Max Occurrence

Hint

String

Hint for the password.

Yes

0/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 password</Hint>
</PasswordKeyInfoSpec>

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. Possible values:

  • application/xml
  • application/json

Response Body

None.

Example

The example below updates the hint parameter in the password having ID c473b8df-4499-41b8-ba6b-7f76def6fea1 on the Veeam backup server with ID f62624c1-8462-4747-8bd4-d686f99b0540.

Request:

PUT https://localhost:9398/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540/passwords/c473b8df-4499-41b8-ba6b-7f76def6fea1

 

Request Headers:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Content-Type         application/xml

 

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 password</Hint>
</PasswordKeyInfoSpec>

 

Response:

204 No Content

 

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VVeeam Backup Enterprise Manager GuideVeeam Agent Management GuideVeeam Cloud Connect GuideVeeam Explorers User GuideVeeam Plug-ins for Enterprise Applications GuideVeeam PowerShell ReferenceVeeam Explorers PowerShell ReferenceVeeam RESTful API ReferenceRequired Permissions for VMware vSphereQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Backup for AWS DocumentationVeeam Backup for Microsoft Azure DocumentationVeeam Backup for Nutanix AHV User GuideVeeam Backup for Microsoft Office 365 DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

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