This is an archive version of the document. To get the most up-to-date information, see the current version.(PUT) /backupServers/{ID}/credentials/{ID}
Edits a credentials record having specified ID on the Veeam backup server with the specified ID.
Request
To edit a credentials record, you need to send the PUT HTTP request to the URL of the /backupServers/{ID}/credentials/{ID} resource.
HTTP Request
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 credentials record 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.
The request body must contain the elements you want to edit:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
Username | String | User name of the edited credentials record in the DOMAIN\USENAME format. | Yes | 0/1 |
Description | String | Description of the edited credentials record. | Yes | 0/1 |
Password | String | Password of the edited credentials. | Yes | 0/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 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 password parameter in the credentials record having ID c473b8df-4499-41b8-ba6b-7f76def6fea1 on the Veeam backup server with ID f62624c1-8462-4747-8bd4-d686f99b0540.
Request: PUT http://localhost:9399/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540/credentials/c473b8df-4499-41b8-ba6b-7f76def6fea1
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Request Body: <?xml version="1.0" encoding="utf-8"?>
Response: 204 No Content |
