This is an archive version of the document. To get the most up-to-date information, see the current version.(POST) /Reports/Action
Sends a test message to a specified email.
Request
To send a test message, send the POST HTTPS request to the URL of the /Reports/Action resource.
HTTPS Request
POST https://<Backup-Office365>:4443/v3/Reports/Action |
Request Headers
The request header must contain the authorization token for the current logon session.
Request Body
The /Reports/Action resource can contain different properties depending on the type of the report:
Generate a License Overview report
To generate a license overview report on the Veeam Backup for Microsoft Office 365 server, the request body must contain the generate action properties:
Property | Type | Description |
Type | string | Specifies the type of a report you want to generate. For example, "type": "licenseOverview". |
StartTime | string | Specifies a beginning time of the reporting interval. For example, "startTime": "2018.10.04 15:25:00". |
EndTime | string | Specifies an ending time of the the reporting interval. For example, "endTime": "2018.11.17 12:30:00". |
Format | string | Specifies the type of the format for the generated report:
For example, "format": "pdf". |
For example:
{ "generate": { "type": "licenseOverview", "startTime": "2018.10.04 15:25:00", "endTime": "2018.11.17 12:30:00", "format": "pdf" } } |
Generate a Storage Consumption report
To generate a Storage Consumption report on the Veeam Backup for Microsoft Office 365 server, the request body must contain the generate action properties:
Property | Type | Description |
Type | string | Specifies the type of a report you want to generate. For example, "type": "storageConsumption". |
StartTime | string | Specifies a beginning time of the reporting interval. For example, "startTime": "2018.10.04 15:25:00". |
EndTime | string | Specifies an ending time of the the reporting interval. For example, "endTime": "2018.11.17 12:30:00". |
Format | string | Specifies the type of the format for the generated report:
For example, "format": "pdf". |
For example:
{ "generate": { "type": "licenseOverview", "startTime": "2018.10.04 15:25:00", "endTime": "2018.11.17 12:30:00", "format": "pdf" } } |
Generate a Mailbox Protection report
To generate a Mailbox Protection report on the user mailboxes protected by the Veeam Backup for Microsoft Office 365 server, the request body must contain the generate action properties:
Property | Type | Description |
Type | string | Specifies the type of a report you want to generate. For example, "type": "mailboxProtection". |
OrganizationId | string | Specifies an ID of an organization for which the protected user mailboxes report will be generated. For example, "organizationId": "d6ce571c-c583-466e-bbcc-5bb5078fa6b9" |
Format | string | Specifies the type of the format for the generated report:
For example, "format": "pdf". |
For example:
{ "generate": { "type": "mailboxProtection", "organizationId": "d6ce571c-c583-466e-bbcc-5bb5078fa6b9", "format": "pdf" } } |
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
The example below shows how to generate a Mailbox Protection report.
Request: POST https://support.east.local:4443/v3/Reports/Action Request Header: Authorization: Bearer <Access-Token>
Request Body: { "generate": { "type": "mailboxProtection", "organizationId": "d6ce571c-c583-466e-bbcc-5bb5078fa6b9", "format": "pdf" } }
Response: 200 OK |