This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBORestAPISettings

In this article

Short Description

Modifies RESTful API settings.

Syntax

Set-VBORestAPISettings [-EnableService [<SwitchParameter>]] [-AuthTokenLifeTime <Int32>] [-HTTPSPort <Int32>] [-CertificateFilePath <String>] [-CertificatePassword <SecureString>] [<CommonParameters>]

Detailed Description

This cmdlet modifies RESTful API settings which are used by Veeam Backup for Microsoft Office 365 RESTful API Service. For SSL connections, Veeam Backup for Microsoft Office 365 RESTful API uses SSL certificate.

Set-VBORestAPISettings Note:

This cmdlet accepts SecureString type. Use Microsoft PowerShell standard capabilities to convert your password into the SecureString.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Enable Service	Indicates that the cmdlet will start Veeam Backup for Microsoft Office 365 RESTful API Service.	False	Named	False	False
AuthToken LifeTime	Specifies the lifetime value for the authentication token (minutes).	False	Named	False	False
HTTPSPort	Specifies the port for server-client communication over HTTPS protocol.	False	Named	False	False
Certificate FilePath	Specifies the path to SSL certificate file.	False	Named	False	False
Certificate Password	Specifies the password for SSL certificate.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example

This example shows how to modify RESTful API settings:

Set authentication token lifetime to 4800 minutes
Locate the SSL certificate file and type certificate's password

You will need to perform the following steps:

Assign your certificate password to the $plainpassword variable.
Run ConvertTo-SecureString with the $plainpassword variable to turn the password into SecureString type. Save the result to the $securepassword variable.
Run Set-VBORestAPISettings with the $securepassword variable.

The password is turned into a SecureString by running ConvertTo-SecureString and assigned to the $securepassword variable.

$plainpassword = "Password1234plain"

$securepassword = $plainpassword | ConvertTo-SecureString -AsPlainText -Force

Set-VBORestAPISettings -EnableService -AuthTokenLifeTime 4800 -CertificateFilePath "C:\Certificates" -CertificatePassword $securepassword