Skip to content
PalomPalomAtlas

Set Retention

PUT
/api/v1/object/retention
curl --request PUT \
  --url 'https://example.com/api/v1/object/retention?key=example&bucket=example' \
  --header 'Content-Type: application/json' \
  --data '{ "retain_until": "2026-04-15T12:00:00Z" }'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
key
required
Key
string
bucket
required
Bucket
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
SetRetentionRequest
object
retain_until
required
Retain Until
string format: date-time
Examplegenerated
{
  "retain_until": "2026-04-15T12:00:00Z"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SetRetentionResponse
object
retention
required
RetentionConfigModel
object
mode
required
Mode
string
Allowed values: GOVERNANCE COMPLIANCE
retain_until
required
Retain Until
string format: date-time
Example
{
  "retention": {
    "mode": "GOVERNANCE"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}