Retrieving Bucket Compliance Retention Policies
Updated at:2025-11-03
API description
This API fetches the configuration details of a compliance retention policy.
Request URI
GET /v1/{bucketName}/?objectlock
| Parameter name | Parameter type | Required or not | Description | Example value | Parameter location |
|---|---|---|---|---|---|
| bucketName | String | Yes | Bucket name | "bucketName_example" | Path |
Parameters of request body
Description of the data structure of request body fields
Response body parameters
Description of the data structure of response body fields
| Parameter name | Parameter type | Description | Example value |
|---|---|---|---|
| lockStatus | String | Compliance retention policy status | IN_PROGRESS |
| createDate | Integer | Creation time compliance of a compliance retention policy | 1569317168 |
| expirationDate | Integer | Expiration time of a compliance retention policy. It may only expire when being in IN_PROGRESS status. | 1569403568 |
| retentionDays | Integer | Compliance retention protection period in days. | 3 |
Request example
JSON
1GET /v1/bucketName_example/?objectlock
2 <Common request headers>
3{ }
Response example
JSON
1HTTP/1.1 200 OK
2 <Common response headers>
3{
4 "lockStatus" : "IN_PROGRESS",
5 "retentionDays" : 3,
6 "createDate" : 1569317168,
7 "expirationDate" : 1569403568
8}
Error code
Please refer to the general error codes
