Initial Configuration

The /InitialConfiguration collection allows you to perform the initial configuration of the Veeam Backup for AWS appliance.

Configure Backup ApplianceDeprecated

The HTTP POST request to the /initConfig endpoint performs the initial configuration of the backup appliance after Veeam Backup for AWS deployment from an Amazon Machine Image (AMI).

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: multipart/form-data
required

configurationMode required	string Defines the configuration mode that will be used to set up the Veeam Backup for AWS appliance. Enum: "automatic" "manual"
username required	string Specifies a name for the default user.
password required	string <password> Specifies a password for the default user.
timeZone required	string Specifies a time zone in which the appliance will operate.
eulaChecksum required	string Checksum for accepting terms of the Veeam license agreement. Note: To read the agreement and get the `checksum` parameter required for accepting the license agreement, send the HTTP GET request to the /api/v1/licenseAgreement endpoint.
thirdPartyLicenseAgreementChecksum required	string Checksum for accepting terms of the 3rd party components license agreements. Note: To read the agreements and get the `checksum` parameter required for accepting the license agreements, send the HTTP GET request to the /api/v1/licenseAgreement endpoint.
licensingPolicyChecksum required	string Checksum for accepting terms of the Veeam license policy. Note: To read the policy and get the `checksum` parameter required for accepting the license policy, send the HTTP GET request to the /api/v1/licenseAgreement endpoint.
requiredSoftwareChecksum required	string Checksum for accepting 3rd party software license agreements. Note: To read the agreements and get the `checksum` parameter required for accepting the license agreements, send the HTTP GET request to the /api/v1/licenseAgreement endpoint.
accessKey	string [Applies if the automatic value is specified for the `configurationMode` parameter] Specifies an AWS access key required for automatic creation of IAM roles and a lifecycle policy used to protect the appliance data.
secretKey	string [Applies if the automatic value is specified for the `configurationMode` parameter] Specifies an AWS secret key required for automatic creation of IAM roles and a lifecycle policy used to protect the appliance data.
IAMRole	string [Applies if the manual value is specified for the `configurationMode` parameter] Specifies an IAM role created beforehand as described in the Veeam Backup for AWS.
licenseFile	string <binary> License file in the .lic format.

Responses

202

Accepted

400

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

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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

post/api/v1/initConfig

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/initConfig \
  -H 'Content-Type: multipart/form-data' \
  -H 'x-api-version: 1.7-rev0' \
  -F configurationMode=automatic \
  -F accessKey=string \
  -F secretKey=string \
  -F IAMRole=string \
  -F username=string \
  -F 'password=pa$$word' \
  -F timeZone=string \
  -F eulaChecksum=string \
  -F thirdPartyLicenseAgreementChecksum=string \
  -F licensingPolicyChecksum=string \
  -F requiredSoftwareChecksum=string \
  -F licenseFile=string

Response samples

{"sessionId": "1b1a25b9-1131-469a-914c-5318b0aa1b07",
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/1b1a25b9-1131-469a-914c-5318b0aa1b07"
}
]
}

Get Appliance Configuration StatusDeprecated

The HTTP GET request to the /initConfig/status endpoint retrieves the status of the backup appliance configuration operation.

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

400

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

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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/initConfig/status

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/initConfig/status \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"status": "notConfigured"
}

Validate Initial Configuration SettingsDeprecated

The HTTP POST request to the /initConfig/validate endpoint checks whether the settings you plan to specify for initial configuration of the backup appliance are valid.

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: multipart/form-data
required

configurationMode required	string Defines the configuration mode that will be used to set up the Veeam Backup for AWS appliance. Enum: "automatic" "manual"
username required	string Specifies a name for the default user.
password required	string <password> Specifies a password for the default user.
timeZone required	string Specifies a time zone in which the appliance will operate.
eulaChecksum required	string Checksum for accepting terms of the Veeam license agreement. Note: To read the agreement and get the `checksum` parameter required for accepting the license agreement, send the HTTP GET request to the /api/v1/licenseAgreement endpoint.
thirdPartyLicenseAgreementChecksum required	string Checksum for accepting terms of the 3rd party components license agreement. Note: To read the agreements and get the `checksum` parameter required for accepting the license agreements, send the HTTP GET request to the /api/v1/licenseAgreement endpoint.
licensingPolicyChecksum required	string Checksum for accepting terms of the Veeam license policy. Note: To read the policy and get the `checksum` parameter required for accepting the license policy, send the HTTP GET request to the /api/v1/licenseAgreement endpoint.
requiredSoftwareChecksum required	string Checksum for accepting 3rd party software license agreements. Note: To read the agreements and get the `checksum` parameter required for accepting the license agreements, send the HTTP GET request to the /api/v1/licenseAgreement endpoint.
accessKey	string [Applies if the automatic value is specified for the `configurationMode` parameter] Specifies an AWS access key required for automatic creation of IAM roles and a lifecycle policy used to protect the appliance data.
secretKey	string [Applies if the automatic value is specified for the `configurationMode` parameter] Specifies an AWS secret key required for automatic creation of IAM roles and a lifecycle policy used to protect the appliance data.
IAMRole	string [Applies if the manual value is specified for the `configurationMode` parameter] Specifies an IAM role created beforehand as described in the Veeam Backup for AWS User Guide.
licenseFile	string <binary> License file in the .lic format.

Responses

200

400

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

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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

post/api/v1/initConfig/validate

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/initConfig/validate \
  -H 'Content-Type: multipart/form-data' \
  -H 'x-api-version: 1.7-rev0' \
  -F configurationMode=automatic \
  -F accessKey=string \
  -F secretKey=string \
  -F IAMRole=string \
  -F username=string \
  -F 'password=pa$$word' \
  -F timeZone=string \
  -F eulaChecksum=string \
  -F thirdPartyLicenseAgreementChecksum=string \
  -F licensingPolicyChecksum=string \
  -F requiredSoftwareChecksum=string \
  -F licenseFile=string

Response samples

{"messages": [{"severity": "Warning",
"message": "string",
"contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6"
}
]
}

Get Configuration Session DataDeprecated

The HTTP GET request to the /initConfig/{sessionId} endpoint retrieves information on the appliance configuration session.

Request

path Parameters

sessionId

required

string <uuid>

System ID assigned to the appliance configuration session in the Veeam Backup for AWS REST API.

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

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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/initConfig/{sessionId}

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/initConfig/{sessionId}' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
"name": "string",
"type": "Policy",
"extendedSessionType": "Other",
"executionStartTime": "2019-08-24T14:15:22Z",
"executionStopTime": "2019-08-24T14:15:22Z",
"executionDuration": 0,
"status": "Running",
"result": "Running",
"reason": "string",
"usn": 0,
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
],
"_embedded": {"backupJobInfo": {"rel": "string",
"href": "string",
"method": "GET"
},
"restoreJobInfo": {"rel": "string",
"href": "string",
"method": "GET"
},
"retentionJobDeletedRestorePoints": {"rel": "string",
"href": "string",
"method": "GET"
}
}
}

Validate User NameDeprecated

The HTTP POST request to the /initConfig/validate/userName endpoint checks whether a user name you plan to specify for a new user is unique and meets the Veeam Backup for AWS requirements.

NOTE
A name of a Veeam Backup for AWS user can contain only lowercase Latin letters, numeric characters, underscores and dashes. You can use the dollar sign ($) as the last character of the user name.

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

name

required

string non-empty

Name that you plan to specify for a user.

Responses

200

400

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

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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

post/api/v1/initConfig/validate/userName

Request samples

{"name": "rayan_smith"
}

Response samples

{"messages": [{"severity": "Warning",
"message": "string",
"contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6"
}
]
}

Validate User PasswordDeprecated

The HTTP POST request to the /initConfig/validate/password endpoint checks whether a user password you plan to specify for a user meets the Veeam Backup for AWS requirements.

NOTE
To meet the security level required in Veeam Backup for AWS, password must be at least 8 characters long and contain uppercase, lowercase letters and numeric characters. Do not use monotonic sequences in the password.

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

password

required

string non-empty

Password that you plan to specify for a user.

Responses

200

400

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

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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

post/api/v1/initConfig/validate/password

Request samples

{"password": "Administrator1"
}

Response samples

{"messages": [{"severity": "Warning",
"message": "string",
"contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6"
}
]
}

Check PermissionsDeprecated

The HTTP POST request to the /initConfig/checkPermissions endpoint checks whether the specified IAM role has all the required permissions to perform backup and restore operations.

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

IAMRole required	string Specifies an IAM role to be used to perform the initial configuration of the Veeam Backup for AWS appliance.
instanceId	string Specifies the ID of the EC2 instance where Veeam Backup for AWS is installed.

Responses

200

400

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

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

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

post/api/v1/initConfig/checkPermissions

Request samples

{"instanceId": "string",
"IAMRole": "string"
}

Response samples

{"needPermission": ["string"
]
}

Get Available Time ZonesDeprecated

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

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

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/initConfig/timeZones

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/initConfig/timeZones \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"items": [{"name": "Africa/Abidjan",
"displayName": "Africa/Abidjan +00:00"
},
{"name": "Africa/Accra",
"displayName": "Africa/Accra +00:00"
},
{"name": "Africa/Addis_Ababa",
"displayName": "Africa/Addis_Ababa +03:00"
},
{"name": "Africa/Algiers",
"displayName": "Africa/Algiers +01:00"
}
]
}

Initial Configuration

Configure Backup ApplianceDeprecated

header Parameters

Request Body schema: multipart/form-datarequired

Get Appliance Configuration StatusDeprecated

header Parameters

Validate Initial Configuration SettingsDeprecated

header Parameters

Request Body schema: multipart/form-datarequired

Get Configuration Session DataDeprecated

path Parameters

header Parameters

Validate User NameDeprecated

header Parameters

Request Body schema: application/jsonapplication/problem+jsonapplication/jsonrequired

Validate User PasswordDeprecated

header Parameters

Request Body schema: application/jsonapplication/problem+jsonapplication/jsonrequired

Check PermissionsDeprecated

header Parameters

Request Body schema: application/jsonapplication/problem+jsonapplication/jsonrequired

Get Available Time ZonesDeprecated

header Parameters

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required