Veeam Backup for AWS 9
REST API Reference
Related documents

Identity Provider

The /saml2 collection represents HTTP requests used to configure single sign-on settings in Veeam Backup for AWS.

Import Identity Provider Settings

The HTTP POST request to the /saml2/registerProvider endpoint allows you to import to Veeam Backup for AWS the metadata file with the identity provider settings.

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

Identity Provider metadata file.

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/saml2/registerProvider
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/saml2/registerProvider \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: multipart/form-data' \
  -H 'x-api-version: 1.7-rev0' \
  -F providerDescriptionFile=string
Response samples
application/json
{
  • "entityId": "1bgrfeab-5e63-4b4c-32e5-35379e904027"
}

Enable Identity Provider

The HTTP POST request to the /saml2/enable endpoint enables using an external identity provider for authentication in Veeam Backup for AWS.

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.

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/saml2/enable
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/saml2/enable \
  -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": {
    }
}

Disable Identity Provider

The HTTP POST request to the /saml2/disable endpoint disables using the external identity provider for authentication in Veeam Backup for AWS.

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.

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/saml2/disable
Request samples 
curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/saml2/disable \
  -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": {
    }
}

Export Service Provider Settings

The HTTP GET request to the /saml2 endpoint allows you to export service provider settings to a metadata file that must be passed to the identity provider.

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.

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/saml2
Request samples 
curl -i -X GET \
  https://helpcenter.veeam.com/api/v1/saml2 \
  -H 'x-api-version: 1.7-rev0'