---
title: "Set-VBORestAPISettings"
description: "This cmdlet modifies REST API settings that are used by Veeam Backup for Microsoft 365 REST API Service. For TLS connections, Veeam Backup for Microsoft 365 REST API uses a TLS certificate."
canonical: "https://helpcenter.veeam.com/docs/vbo365/powershell/set-vborestapisettings.html"
breadcrumb: "PowerShell Reference > Veeam Backup for Microsoft 365 PowerShell Reference > REST API Settings > Set-VBORestAPISettings"
dateModified: "2026-08-21"
---

# Set-VBORestAPISettings

## Short Description
Modifies REST API settings.

## Syntax
```
Set-VBORestAPISettings [-EnableService] [-AuthTokenLifeTime <Int32>] [-HTTPSPort <Int32>]
 [-CertificateFilePath <String>] [-CertificatePassword <SecureString>] [-EnableSwaggerUI]
 [-EnableOperatorAuthenticationOnly] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies REST API settings that are used by *Veeam Backup for Microsoft 365* *REST API Service*. For TLS connections, Veeam Backup for Microsoft 365 REST API uses a TLS certificate.

To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

::: note

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

:::

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">AuthTokenLifeTime</span></p>
        </td>
        <td>
          <p>Specifies the lifetime value for the authentication token (minutes).</p><p>Default: <em>60</em></p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">CertificateFilePath</span></p>
        </td>
        <td>
          <p>Specifies a path to the TLS certificate file.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">CertificatePassword</span></p>
        </td>
        <td>
          <p>Specifies a password for the TLS certificate.</p>
        </td>
        <td style="width:10%;">
          <p><code>SecureString</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableOperatorAuthenticationOnly</span></p>
        </td>
        <td>
          <p>Defines that Veeam Backup for Microsoft 365 will use REST API only for authentication of restore operators to Restore Portal.</p><p>Default: <em>False</em></p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableService</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will start <em>Veeam Backup for Microsoft 365</em> <em>REST API Service</em>.</p><p>Default: <em>False</em></p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableSwaggerUI</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will enable access to the swagger website and usage of Swagger UI.</p><p>Default: <em>False</em></p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">HTTPSPort</span></p>
        </td>
        <td>
          <p>Specifies a port number for server-client communication over HTTPS protocol.</p><p>Default: <em>4443</em></p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the [About Common Parameters](http://go.microsoft.com/fwlink/p/?LinkID=113216) section of Microsoft Learn.

## Output Object
The cmdlet returns the [`VBORestAPISettings`](vborestapisettings.md) object that contains REST API settings.

## Examples

::: example
### Modifying REST API Settings

This example shows how to modify REST API settings:

- Set authentication token lifetime to 4800 minutes.
- Locate the TLS certificate file and specify the certificate password.

```
$plainpassword = "Password1234plain"
$securepassword = $plainpassword | ConvertTo-SecureString -AsPlainText -Force
Set-VBORestAPISettings -EnableService -AuthTokenLifeTime 4800 -CertificateFilePath "C:\Certificates" -CertificatePassword $securepassword
```

Perform the following steps:

1. Assign your certificate password to the `$plainpassword` variable.
2. Run the [`ConvertTo-SecureString`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/convertto-securestring) cmdlet with the `$plainpassword` variable to turn the password into the `SecureString` type. Save the result to the `$securepassword` variable.
3. Run the `Set-VBORestAPISettings` cmdlet. Specify the following settings:

   - Provide the `EnableService` parameter.
   - Specify the `AuthTokenLifeTime` parameter value.
   - Specify the `CertificateFilePath` parameter value.
   - Set the `$securepassword` variable as the `CertificatePassword` parameter value.

:::

## Related Commands

[``ConvertTo-SecureString``](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/convertto-securestring)