REST API Settings

You can use REST API to communicate with Veeam Backup for Microsoft 365. For more information, see REST API Reference.

Also, REST API is used by Restore Portal to communicate with the Veeam Backup for Microsoft 365 server. Restore Portal allows users to perform self-service restore. For more information about Restore Portal, see Data Restore Using Restore Portal.

To configure Veeam Backup for Microsoft 365 REST API settings, do the following:

In the main menu, click General Options.
Open the REST API tab.
Select the Enable REST service check box.
In the Authentication token lifetime field, specify the lifetime value for an authentication token (in minutes).

REST API authorization is based on the OAuth 2.0 Authorization Framework.

In the HTTPS port field, specify a port number which you use to access Veeam Backup for Microsoft 365 REST API Service.

Also, Restore Portal uses this port to communicate with Veeam Backup for Microsoft 365 REST API Service. For more information, see Ports.

Note

The default value is 4443. If you use a different port, make sure that you configure the same value for the Restore Portal web address. Otherwise, Restore Portal will be unavailable. For more information, see Register Microsoft Entra Application and Configure Microsoft Entra Application.

Click Install to run the Select Certificate wizard and install the REST API certificate. Proceed to any of the following options:

Generate a new self-signed certificate

Perform the following steps:

Select the Generate a new self-signed certificate option.

REST API Settings

Specify a certificate name and click Finish.

REST API Settings

Import an existing TLS certificate from the certificate store

Perform the following steps:

Select the Select certificate from the Certificate Store of this server option.

REST API Settings

Select the certificate from the certificate store and click Finish.

Note

A TLS certificate that you want to use must be added to the Personal certificate store. It also must have a private exportable key.

REST API Settings

Import a TLS certificate from a file in the PFX format

Perform the following steps:

Select the Import certificate from a PFX file option.

REST API Settings

Click Browse and select a PFX file. Specify the certificate password if required.

Note

A TLS certificate that you want to use must have a private exportable key.

REST API Settings

Click Finish.

If you want to use Swagger UI, select the Enable Swagger UI check box. If you do not require permanent access, leave the check box clear to reduce the potential attack surface.
Select the Enable restore operator authentication only check box to use REST API only for authentication of restore operators to Restore Portal. Keep in mind that if you enable this check box, all other REST API endpoints will be unavailable.
Click OK.

REST API Settings