This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Retention Settings
This section explains how to get retention settings of:
- Lingering snapshots retention
- Sessions retention
Request
GET https://<hostname>/api/v1/settings/retention |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
None.
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
Property | Type | Description |
|---|---|---|
sessionsSettings | Contains session retention settings. | |
lingeringSnapshotsSettings | Contains lingering retention settings. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
|---|---|---|
duration | int32 | Shows a duration of both the sessions and the lingering retention. |
type | string | Shows a duration type. Can be either Daily or Monthly. |
keepForever | boolean | Shows if sessions and lingering retention data records must be kept forever. |
Example
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/settings/retention
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "sessionsSettings": { "duration": 365, "type": "Daily", "keepForever": false }, "lingeringSnapshotsSettings": { "duration": 90, "type": "Daily", "keepForever": false }, "_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/settings/retention"}} } |