Help Center
Choose product document...
Veeam Backup for Microsoft Office 365
RESTful API Reference

(GET) /Proxies/{ID}

Returns a resource representation of a backup proxy with the specified ID.

Request

To get a resource representation of a backup proxy, send the GET HTTPS request to the URL of the/Proxies/{ID}resource:

HTTPS Request

GET https://<Backup-Office365>:<Port>/v1/Proxies/{ID}

Request Headers

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

Request Body

None.

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

In the response body, the server returns a representation of the /Proxies/{ID} resource.

Example

The example below returns an entity representation of a backup proxy with ID 46d10221-7974-42d7-bb38-f80e65f95f3d.

Request:

GET https://support.east.local:4443/v1/Proxies/46d10221-7974-42d7-bb38-f80e65f95f3d

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

 {

   "id": "46d10221-7974-42d7-bb38-f80e65f95f3d",

   "hostName": "sales.east.local",

   "description": "ABC Company Sales",

   "port": 9193,

   "threadsNumber": 32,

   "enableNetworkthrottling": "true",

   "throttlingValue": 1250,

   "throttlingUnit": "KBs",

   "status": "Online",

   "_links": {

     "self": {

       "href": "https://support.east.local:4443/v1/Proxies/46d10221-7974-42d7-bb38-f80e65f95f3d"

     },

     "repositories": {

       "href": "https://support.east.local:4443/v1/Proxies/46d10221-7974-42d7-bb38-f80e65f95f3d/repositories"

     }

   }

 }

Related Topics

Configuring Backup Proxies

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference