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

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

Returns a resource representation of a password with the specified ID created on the Veeam backup server with the specified ID.

Request

To get a resource representation of the password created on a specific Veeam backup server, you need to send the GET HTTP request to the URL of the /backupServers/{ID}/passwords/{ID} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/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.

Request Body

None.

Query Parameters

The following parameters can be used in queries.

Parameter

Type

Description

Can Be Used for Filtering

Can Be Used for Sorting

PasswordKeyID

String

ID of the password created on the Veeam backup server, for example: bd2fe652-b6c0-4f9f-b466-e10c4dc3e3da

True

False

Hint

String

Hint for the password.

True

False

BackupServerUid

URN

ID of the Veeam backup server on which the credentials record has been created, for example: urn:veeam:BackupServer:15942270-fb56-4dcc-96e9-5f80e4725a15.

True

False

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 Success.

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

In the response body, Veeam Backup Enterprise Manager returns a representation of the /backupServers/{ID}/passwords/{ID} resource.

Example

The example below returns a password having ID cacd84ea-5cc9-46b5-9e79-2162c4170662 created on the Veeam backup server having ID 50a1b2fb-b90a-4e05-816f-e298eb2f995c.

Request:

GET http://localhost:9399/api/backupServers/50a1b2fb-b90a-4e05-816f-e298eb2f995c/passwords/cacd84ea-5cc9-46b5-9e79-2162c4170662

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<PasswordKeyInfo xmlns="http://www.veeam.com/ent/v1.0" Type="PasswordKey" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/passwords/cacd84ea-5cc9-46b5-9e79-2162c4170662">
 <Links>
   <Link Rel="Up" Type="BackupServer" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018?format=Entity" Name="srv02.veeam.local" />
   <Link Rel="Edit" Type="PasswordKey" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/passwords/cacd84ea-5cc9-46b5-9e79-2162c4170662" />
   <Link Rel="Delete" Type="PasswordKey" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/passwords/cacd84ea-5cc9-46b5-9e79-2162c4170662" />
 </Links>
 <Id>cacd84ea-5cc9-46b5-9e79-2162c4170662</Id>
 <Hint>My password</Hint>
 <LastModificationDate>2014-10-10T23:06:17-08:00</LastModificationDate>
</PasswordKeyInfo>

 

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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation