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

Removing Backup Proxy Servers

You can remove a backup proxy server with the specified ID from the Veeam Backup for Microsoft Office 365 configuration.

Request

POST https://<hostname>:4443/v5/Proxies/{proxyId}/action

Removing Backup Proxy Servers Note

The DELETE https://<hostname>:4443/<version>/Proxies/{proxyId} request used to remove a backup proxy server in previous versions of Veeam Backup for Microsoft Office 365 is not available in version 5.0 of the product.

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter	Type	Description
proxyId	string	Specifies the identification number of the backup proxy server. For more information on how to get this parameter, see Getting Backup Proxy Servers.

Request Body

To remove a backup proxy server, the request body must contain the remove action properties:

Property	Type	Description
userName	string	Specifies the user name of the account used for authentication with the server on which the backup proxy server is installed.
userPassword	string	Specifies the password of the user account used for authentication with the server on which the backup proxy server is installed.
force	string	Defines whether Veeam Backup for Microsoft Office 365 must remove the backup proxy server in the following cases: Veeam Backup for Microsoft Office 365 cannot connect to the backup proxy server. The backup proxy server is in use by Veeam Backup for Microsoft Office 365. The backup proxy server you want to remove is the default backup proxy server in Veeam Backup for Microsoft Office 365. If you do not set this property to true, Veeam Backup for Microsoft Office 365 will not remove a backup proxy server in these conditions.

Property

Type

Description

userName

string

Specifies the user name of the account used for authentication with the server on which the backup proxy server is installed.

userPassword

string

Specifies the password of the user account used for authentication with the server on which the backup proxy server is installed.

force

string

Defines whether Veeam Backup for Microsoft Office 365 must remove the backup proxy server in the following cases:

Veeam Backup for Microsoft Office 365 cannot connect to the backup proxy server.
The backup proxy server is in use by Veeam Backup for Microsoft Office 365.
The backup proxy server you want to remove is the default backup proxy server in Veeam Backup for Microsoft Office 365.

If you do not set this property to true, Veeam Backup for Microsoft Office 365 will not remove a backup proxy server in these conditions.

For example:

Request Body:

{

"remove":

{

"userName": "name",

"userPassword": "password",
"force": false

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

None.

Examples

Example 1

This example shows how to remove a backup proxy server with the 46d10221-7974-42d7-bb38-f80e65f95f3d ID.

Request:

POST https://abc.tech.local:4443/v5/Proxies/46d10221-7974-42d7-bb38-f80e65f95f3d/action

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

"remove":

{

"userName": "name",

"userPassword": "password",
"force": false

}

Response:

200 OK