Rescanning or Removing Backup Proxy Servers

This section explains how to rescan or remove backup proxy servers.

Request

GET https://<hostname>:4443/v4/Proxies/{proxyId}/Action

Request Headers

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

Request Parameters

The following parameters must be posted as URL.

Parameter

Type

Description

proxyId

string

An identification number of the backup proxy server.

Request Body

Rescan a backup proxy

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

{

 "rescan": null

}

Remove a backup proxy

To remove a backup proxy server, the request body must contain the remove action and credentials for the server on which the backup proxy server is installed:

{

 "remove":

 {

   "username": "password",

   "userPassword": "name"

 }

}

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.

Example 1

The example below shows how to rescan a backup proxy with the 46d10221-7974-42d7-bb38-f80e65f95f3d ID.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "rescan": null

}

 

Response:

200 OK

Example 2

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

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "remove":

 {

   "username": "password",

   "userPassword": "name"

 }

}

 

Response:

200 OK

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.