Veeam Backup for AWS 9
REST API Reference
Related documents

Authorization

Veeam Backup for AWS REST API authorization process involves obtaining an access token — a string that represents authorization issued to the user and that must be sent in the Bearer <Access-Token> format in the Authorization header in all requests during the current logon session.

Bearer

Authenticates a user (client) who sends the request to the server. Must contain the access token for the current logon session.

Security Scheme Type: API Key
Header parameter name: Authorization

The /token resource collection allows a Veeam Backup for AWS user to authenticate himself and authorize his access to the Veeam Backup for AWS REST API. To authenticate a user retrieved from the identity provider, see Authorization (Single Sign-On).
To learn more about the authorization process and security settings, see the Veeam Backup for AWS REST API Reference Overview, section Authorization and Security.

Request Authorization Tokens

The HTTP POST request to the /token endpoint allows you to authorize your access to the Veeam Backup for AWS REST API.

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/x-www-form-urlencoded
required
grant_type
required
string

Grant type that will be used to authenticate a user.

Enum: "password" "refresh_token" "authorization_code" "mfa"
username
string

[Required if the grant_type paramenter value is password] User name.

password
string <password>

[Required if the grant_type paramenter value is password] Password of the user.

refresh_token
string

[Required if the grant_type paramenter value is refresh_token] Refresh token.

code
string

[Required if the grant_type paramenter value is authorization_code] Authorization code.

mfa_token
string

[Required if the grant_type paramenter value is mfa] MFA token.

mfa_code
string

[Required if the grant_type paramenter value is mfa] Verification code.

Responses
200

OK

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).

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/token
Request samples
application/x-www-form-urlencoded
grant_type=password&username=string&password=pa%24%24word&refresh_token=string&code=string&mfa_token=string&mfa_code=string
Response samples
[
  • {
    }
]

Logout

The HTTP DELETE request to the /token endpoint performs the logout operation for an authorized user.

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
204

No Content

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).

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

delete/api/v1/token
Request samples 
curl -i -X DELETE \
  https://helpcenter.veeam.com/api/v1/token \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 400,
  • "errorCode": "AccessDenied",
  • "details": "string",
  • "instance": "http://example.com",
  • "data": {
    }
}

Get Authorization Code

The HTTP POST request to the /token/authorizationCode endpoint returns an authorization code used to obtain an access and a refresh tokens.

NOTE
Only an authorized user can obtain an authorization code.
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 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.

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/token/authorizationCode
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/token/authorizationCode \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'
Response samples
{
  • "code": "AAEAAJO1R+DANfH7JDlyUzDVYGDw+77dyaa0mFu8nozvbOreW31Uu1X+mejLUilSp6nBrhcmv9/LTjAjMz3P+grbg1OATjZN7kZ5XbhenJG7DrVUtvpA6h5aDmma8INsMv6xW7+TmcOUNlK65n2J2/rQCjg80rMOSjlpnkQkX2s+tXOxkX+h/GTRSdxCulLhn69Rj+8Qvmh3+h8c3g+RVnhfSWwfxVR1+sFtViNQwQzI3hBRvxivb9IZo9WSYgtDJc8816OrUrIn26h71jYm6WfYn3ZiMp/VkABHqvqAsIMuKD1Xat9lnQyxARc1ZU9suM7Ivd5I7Ew51vMMPhXMetchrGkIAAAAWccK8uTa1wg="
}