This is an archive version of the document. To get the most up-to-date information, see the current version.Modify Credentials Record
You can update an SMTP server credentials record with the specified ID.
Request
To edit credentials record data, send the HTTP PUT request to the /accounts/standard/{standardAccountId} endpoint. {standardAccountId} is a system ID assigned to the SMTP credentials record in the Veeam Backup for AWS REST API.
HTTP Request
PUT https://<hostname>:<port>/api/v1/accounts/standard/{standardAccountId} |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request Body
To specify data to be changed for the record, send the following parameters in the request body.
Parameter | Required/Optional | Type | Description |
|---|---|---|---|
name | Required | string | Specifies a name of the credentials record. |
description | Optional | string | Specifies a description of the credentials record. Note: If you do not send the description parameter in the request body, the value is set to null by default. |
username | Required | string | Specifies a user name of an account used by Veeam Backup for AWS to authenticate against an SMTP server. |
password | Optional | string | Specifies a password of the account used by Veeam Backup for AWS to authenticate against an SMTP server. |
Note |
Before update an SMTP server credentials record, you can check whether a name you plan to specify as a record name in Veeam Backup for AWS is unique. For more information, see Validate Credential Record Name. |
Set the parameter values in the following format:
{ "name": "string", "description": "string", "username": "string", "password": "string" } |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-Length | integer | Identifies the length of the response body message, in bytes. |
Content-Type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for AWS returns an updated representation of the SMTP server credentials record. The StandardAccount schema is used for the resource representation.
Example
The following request sets a new name for an SMTP server credential record with the ID 10b074bd-0510-4795-9fdc-d5dce1db66c0.
|