Generating Mailbox Protection Report
You can generate mailbox protection reports on the user mailboxes protected by the Veeam Backup for Microsoft 365 server.
Request
POST https://<hostname>:4443/v6/Reports/GenerateMailboxProtection |
Request Headers
The request header must contain an authorization token of the current session.
Request Body
To generate the Mailbox Protection report, the request body must contain the following properties:
Property | Type | Description |
|---|---|---|
organizationId | string | Specifies an ID of an organization for which the protected user mailboxes report will be generated. |
format | string | Specifies the type of the format for the generated report:
|
timezone | string | Specifies a time zone for the reporting interval. Possible values:
For example: UTC+05:00.
For example: UTC-11:30. If you do not specify this property, the server will generate a report for the UTC time zone. |
For example:
Request Body: { "organizationId": "cbc52c37-df7f-4b03-98f3-036e7d4b3127", "format": "PDF", "timezone": "UTC" } |
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
The example shows how to generate the Mailbox Protection report.
Request: POST https://abc.tech.local:4443/v6/Reports/GenerateMailboxProtection
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "organizationId": "cbc52c37-df7f-4b03-98f3-036e7d4b3127", "format": "PDF", "timezone": "UTC" }
Response: 200 OK |