SMTP and Database Accounts

The /accounts/standard resource collection represents SMTP and database accounts added to the Veeam Backup for Microsoft Azure configuration database.

Add SMTP or Database Account

The HTTP POST request to the /accounts/standard endpoint adds a new SMTP or database account to the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer

Request

Request Body schema: application/json
required

name required	string [ 1 .. 255 ] characters Specifies a name for the account.
kind	string (StandardAccountKind) Specifies the type of the account. Enum: "Smtp" "Database" "Unknown"
description	string or null <= 512 characters Specifies a description for the account.
username	string or null <= 255 characters Specifies a user name that will be used by Veeam Backup for Microsoft Azure to authenticate against a protected Azure database or an SMTP server used for sending email notifications.
password	string or null <= 255 characters Specifies a password that will be used by Veeam Backup for Microsoft Azure to authenticate against a protected Azure database or an SMTP server used for sending email notifications.
	object or null (StandardAccountSqlOptionsFromClient) Specifies SQL options for the account.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/accounts/standard

Request samples

Payload
curl

application/json

{"kind": "Smtp",
"name": "string",
"description": "string",
"username": "string",
"password": "string",
"sqlOptionsFromClient": {"sqlServers": [{"id": "string"
}
]
}
}

Response samples

application/json

{"kind": "Smtp",
"id": "string",
"name": "string",
"description": "string",
"username": "string",
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
}
}

Get Collection of SMTP and Database Accounts

The HTTP GET request to the /accounts/standard endpoint retrieves a list of all SMTP and database accounts added to the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer

Request

query Parameters

Type	Array of strings or null (StandardAccountKind) Returns only accounts of the specified type. Enum: "Smtp" "Database" "Unknown" x-veeam-parameter-group: StandardAccountOptionsV7 x-veeam-model-binder: Veeam.Azure.REST.RequestQuery.V2.CsvModelBinder<Veeam.Azure.Types.Enums.StandardAccountKind>
SearchPattern	string or null Returns only those items of a resource collection whose names match the specified search pattern in the parameter value. x-veeam-parameter-group: StandardAccountOptionsV7
Offset	integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit	integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/accounts/standard

Request samples

curl

curl -i -X GET \
  'https://123.123.123.123/api/v8/accounts/standard?Type=Smtp&SearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
},
"results": [{"kind": "Smtp",
"id": "string",
"name": "string",
"description": "string",
"username": "string",
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
}
}
]
}

Get SMTP and Database Account Names

The HTTP GET request to the /accounts/standard/names endpoint retrieves a list of names of SMTP and database accounts added to the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer

Request

query Parameters

Type	Array of strings or null (StandardAccountKind) Returns only names of accounts of the specified type. Enum: "Smtp" "Database" "Unknown" x-veeam-parameter-group: StandardAccountOptionsV7 x-veeam-model-binder: Veeam.Azure.REST.RequestQuery.V2.CsvModelBinder<Veeam.Azure.Types.Enums.StandardAccountKind>
SearchPattern	string or null Returns only those items of a resource collection whose names match the specified search pattern in the parameter value. x-veeam-parameter-group: StandardAccountOptionsV7
Offset	integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit	integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/accounts/standard/names

Request samples

curl

curl -i -X GET \
  'https://123.123.123.123/api/v8/accounts/standard/names?Type=Smtp&SearchPattern=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
},
"results": [{"id": "string",
"name": "string"
}
]
}

Modify SMTP or Database Account

The HTTP PUT request to the /accounts/standard/{id} endpoint updates an SMTP or database account with the specified ID.

SecurityBearer

Request

path Parameters

required

string

Specifies the ordinal number assigned in the Veeam Backup for Microsoft Azure to an SMTP or a database account.

Request Body schema: application/json
required

name required	string [ 1 .. 255 ] characters Specifies a name for the account.
kind	string (StandardAccountKind) Specifies the type of the account. Enum: "Smtp" "Database" "Unknown"
description	string or null <= 512 characters Specifies a description for the account.
username	string or null <= 255 characters Specifies a user name that will be used by Veeam Backup for Microsoft Azure to authenticate against a protected Azure database or an SMTP server used for sending email notifications.
password	string or null <= 255 characters Specifies a password that will be used by Veeam Backup for Microsoft Azure to authenticate against a protected Azure database or an SMTP server used for sending email notifications.
	object or null (StandardAccountSqlOptionsFromClient) Specifies SQL options for the account.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

put/api/v8/accounts/standard/{id}

Request samples

Payload
curl

application/json

{"kind": "Smtp",
"name": "string",
"description": "string",
"username": "string",
"password": "string",
"sqlOptionsFromClient": {"sqlServers": [{"id": "string"
}
]
}
}

Response samples

application/json

{"kind": "Smtp",
"id": "string",
"name": "string",
"description": "string",
"username": "string",
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
}
}

Remove SMTP or Database Account Data

The HTTP DELETE request to the /accounts/standard/{id} endpoint removes a specific SMTP or database account from the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer

Request

path Parameters

required

string

Specifies the ordinal number assigned in the Veeam Backup for Microsoft Azure to an SMTP or a database account.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

delete/api/v8/accounts/standard/{id}

Request samples

curl

curl -i -X DELETE \
  'https://123.123.123.123/api/v8/accounts/standard/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/problem+json

{"detail": "string",
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"status": 0,
"title": "string",
"traceId": "string",
"type": "string"
}

Get SMTP or Database Account Data

The HTTP GET request to the /accounts/standard/{id} endpoint retrieves information on an SMTP or database account with the specified ID.

SecurityBearer

Request

path Parameters

required

string

Specifies the system ID assigned to an SMTP or database account in the Veeam Backup for Microsoft Azure REST API.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/accounts/standard/{id}

Request samples

curl

curl -i -X GET \
  'https://123.123.123.123/api/v8/accounts/standard/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"kind": "Smtp",
"id": "string",
"name": "string",
"description": "string",
"username": "string",
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
}
}

Export Collection of SMTP and Database Accounts

The HTTP POST request to the /accounts/standard/export endpoint exports a list of SMTP and database accounts added to Veeam Backup for Microsoft Azure to a .CSV or an .XML file.

x-veeam-custom-response: true

SecurityBearer

Request

header Parameters

string or null

Specifies a media type of representation of the exported data. The default value is text/csv media type.

Request Body schema: application/json

type	Array of strings or null (StandardAccountKind) Returns only accounts of the specified type. Enum: "Smtp" "Database" "Unknown" x-veeam-model-binder: Veeam.Azure.REST.RequestQuery.V2.CsvModelBinder<Veeam.Azure.Types.Enums.StandardAccountKind>
searchPattern	string or null Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
accountIds	Array of strings or null Specifies the system IDs assigned in the Veeam Backup for Microsoft Azure REST API to SMTP and database accounts whose data will be exported.

Responses

200

401

Unauthorized

403

Forbidden

post/api/v8/accounts/standard/export

Request samples

Payload
curl

application/json

{"type": ["Smtp"
],
"searchPattern": "string",
"accountIds": ["string"
]
}

Response samples

application/problem+json

{"extensions": { },
"status": 0,
"title": "string",
"type": "string",
"licenseAgreementAcceptanceRequired": true
}

SMTP and Database Accounts

Add SMTP or Database Account

Request Body schema: application/jsonrequired

Get Collection of SMTP and Database Accounts

query Parameters

Get SMTP and Database Account Names

query Parameters

Modify SMTP or Database Account

path Parameters

Request Body schema: application/jsonrequired

Remove SMTP or Database Account Data

path Parameters

Get SMTP or Database Account Data

path Parameters

Export Collection of SMTP and Database Accounts

header Parameters

Request Body schema: application/json

Request Body schema: application/json
required

Request Body schema: application/json
required