Veeam Backup for AWS 9
REST API Reference
Related documents

Time Zone

The /dateTime resource collection represents time zone settings of Veeam Backup for AWS.

Get Current Time Zone

The HTTP GET request to the /settings/dateTime endpoint retrieves the current time zone of the Veeam Backup for AWS appliance.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The Authorization header does not contain an access token, or the provided access token is invalid.

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/settings/dateTime
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/settings/dateTime \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "timezone": {
    },
  • "useCustomSettings": true
}

Set Time Zone

The HTTP POST request to the /settings/dateTime endpoint sets a new time zone for the Veeam Backup for AWS appliance.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: application/json
required
required
object (TimeZone)

Time zone selected for the Veeam Backup for AWS appliance.

useCustomSettings
required
boolean

Defines whether the time zone is customized. By default, Veeam Backup for AWS operates in the UTC timezone.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The Authorization header does not contain an access token, or the provided access token is invalid.

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/settings/dateTime
Request samples
application/json
{
  • "timezone": {
    },
  • "useCustomSettings": true
}
Response samples
{
  • "timezone": {
    },
  • "useCustomSettings": true
}

Get Available Time Zones

The HTTP GET request to the /settings/dateTime/timezones endpoint retrieves a list of all time zones that can be set for the Veeam Backup for AWS appliance.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The Authorization header does not contain an access token, or the provided access token is invalid.

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/settings/dateTime/timeZones
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/settings/dateTime/timeZones \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "items": [
    ]
}

Reset Time Zone to Default Value

The HTTP POST request to the /settings/dateTime/setDefault endpoint resets the time zone of the Veeam Backup for AWS appliance to default value.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The Authorization header does not contain an access token, or the provided access token is invalid.

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/settings/dateTime/setDefault
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/settings/dateTime/setDefault \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "timezone": {
    },
  • "useCustomSettings": false
}

Get Default Time Zone

The HTTP GET request to the /settings/dateTime/getDefault endpoint retrieves default time zone settings of the Veeam Backup for AWS appliance.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The Authorization header does not contain an access token, or the provided access token is invalid.

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/settings/dateTime/getDefault
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/settings/dateTime/getDefault \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "timezone": {
    },
  • "useCustomSettings": false
}