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 or Configure Microsoft Entra Application. |
- Click Install to specify an SSL certificate.
You can generate a new certificate or select an existing certificate using the Select Certificate wizard. For more information, see Installing SSL Certificates.
Keep in mind that Restore Portal also uses this SSL certificate to communicate with the Veeam Backup for Microsoft 365 server and perform restore operations through REST API.
- Select the Enable Swagger UI check box to enable access to the swagger website and usage of Swagger UI.
- 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.
