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

(POST) /Proxies/{proxyId}/Action

In this article

    Rescans or removes backup proxy.

    Request

    To rescan a backup proxy with a specified ID, send POST HTTPS request to the URL of the /Proxies/{proxyId}/Action resource.

    You can perform the following actions:

    HTTPS Request

    GET https://<Backup-Office365>:4443/v3/Proxies/{proxyId}/Action

    Request Headers

    The request header must contain the authorization token for the current logon session.

    Request Body

    Rescan a backup proxy

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

    {

     "rescan": null

    }

    Remove a backup proxy

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

    {

     "remove":

     {

       "username": "password",

       "userPassword": "name"

     }

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns 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 request 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://support.east.local:4443/v3/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://support.east.local:4443/v3/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.