This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /HistorySettings
Returns a resource representation of retention settings for backup job sessions.
Request
To get the job session retention settings, send GET HTTPS request to the URL of the /HistorySettings resource.
HTTPS Request
GET https://<Backup-Office365>:4443/v3/HistorySettings |
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 /HistorySettings resource.
Example
The example below returns an entity representation of retention settings for backup job sessions.
Request: GET https://support.east.local:4443/v3/HistorySettings
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "keepAllsessions": "false", "keeponlyLast": 4, "_links": { "self": { "href": "https://support.east.local:4443/v3/historysettings" } }, "_actions": { "update": { "uri": "https://support.east.local:4443/v3/historysettings", "method": "PUT" } } } |