Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

SSO Settings

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

Get Identity Provider Settings

The HTTP GET request to the /settings/saml2/idp endpoint retrieves identity provider settings configured in Veeam Backup for Microsoft Azure.

SecurityBearer
Request
query Parameters
includeDisabled
boolean
Default: false

Defines whether to include in the response the settings if they are disabled.

Responses
200

OK

get/api/v8/settings/saml2/idp
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/settings/saml2/idp?includeDisabled=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "entityId": "string",
  • "loginUrl": "string",
  • "enabled": true
}

Get Service Provider Settings

The HTTP GET request to the /settings/saml2/sp endpoint retrieves service provider authentication settings that must be forwarded to the identity provider.

SecurityBearer
Responses
200

OK

get/api/v8/settings/saml2/sp
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/settings/saml2/sp \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "entityId": "string",
  • "assertionConsumerUrl": "string",
  • "hasCertificate": true,
  • "certificateThumbprint": "string"
}

Get Service Provider Metadata

The HTTP GET request to the /settings/saml2/sp/metadata endpoint exports the service provider metadata to an .XML file.

x-veeam-custom-response: true
SecurityBearer
Responses
200

OK

get/api/v8/settings/saml2/sp/metadata
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/settings/saml2/sp/metadata \
  -H 'Authorization: YOUR_API_KEY_HERE'

Upload Service Provider Certificate

The HTTP PUT request to the /settings/saml2/sp/certificate endpoint allows you to upload or change the certificate that is used to sign and encrypt requests sent from Veeam Backup for Microsoft Azure to the identity provider.

SecurityBearer
Request
Request Body schema: application/json
required
certificatePfxBase64
string or null

Specifies the new certificate.

password
string or null

Specifies the password used to protect the certificate.

Responses
200

OK

put/api/v8/settings/saml2/sp/certificate
Request samples
application/json
{
  • "certificatePfxBase64": "string",
  • "password": "string"
}

Delete Service Provider Certificate

The HTTP DELETE request to the /settings/saml2/sp/certificate endpoint allows you to delete the certificate that is used to sign and encrypt requests sent from Veeam Backup for Microsoft Azure to the identity provider.

SecurityBearer
Responses
200

OK

delete/api/v8/settings/saml2/sp/certificate
Request samples 
curl -i -X DELETE \
  https://123.123.123.123/api/v8/settings/saml2/sp/certificate \
  -H 'Authorization: YOUR_API_KEY_HERE'

Get Service Provider Certificate

The HTTP GET request to the /settings/saml2/sp/certificate endpoint retrieves information on the certificate that is used to sign and encrypt requests sent from Veeam Backup for Microsoft Azure to the identity provider.

x-veeam-custom-response: true
SecurityBearer
Responses
200

OK

204

No Content

get/api/v8/settings/saml2/sp/certificate
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/settings/saml2/sp/certificate \
  -H 'Authorization: YOUR_API_KEY_HERE'

Import Identity Provider Metadata

The HTTP POST request to the /settings/saml2/idp/register endpoint allows you to import to Veeam Backup for Microsoft Azure the metadata file with the identity provider settings.

SecurityBearer
Request
Request Body schema: application/json
required
xmlBase64
string or null

Specifies the contents of Identity Provider metadata file in the base64 format after the data:application/octet-stream;base64, content header at the beginning.

Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

415

Client Error

post/api/v8/settings/saml2/idp/register
Request samples
application/json
{
  • "xmlBase64": "string"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "licenseAgreementAcceptanceRequired": true
}

Change Identity Provider URL

The HTTP POST request to the /settings/saml2/idp/used endpoint allows you to change the identity provider used for single sign-on.

SecurityBearer
Request
Request Body schema: application/json
required
enabled
required
boolean

Defines whether using an external identity provider for authentication is enabled.

entityId
required
string non-empty

System ID assigned to the identity provider in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

415

Client Error

post/api/v8/settings/saml2/idp/used
Request samples
application/json
{
  • "entityId": "string",
  • "enabled": true
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "licenseAgreementAcceptanceRequired": true
}