v1

latestSwagger 2.02026-07-17123181472.9 KB

OBTenant

Update backup policy of specific tenant

patch/api/v1/obtenants/{namespace}/{name}/backupPolicy

Path parameters

namespacestring required

obtenant namespace

namestring required

obtenant name

Request body

jobKeepDaysinteger

pieceIntervalDaysinteger

recoveryDaysinteger

scheduleTimestring

Description: HH:MM Example: 04:00

scheduleTypestring

Enum: Weekly, Monthly

statusstring

Enum: PAUSED, RUNNING

Example request

{
  "jobKeepDays": 5,
  "pieceIntervalDays": 1,
  "recoveryDays": 3,
  "scheduleDates": [
    {
      "backupType": "Full",
      "day": 3
    }
  ],
  "scheduleTime": "04:00",
  "scheduleType": "Weekly",
  "status": "PAUSED"
}

Response

messagestring required

successfulboolean required

Example response

{
  "data": {
    "jobKeepDays": 5,
    "pieceIntervalDays": 1,
    "recoveryDays": 3,
    "scheduleDates": [
      {
        "backupType": "Full",
        "day": 3
      }
    ],
    "scheduleTime": "04:00",
    "scheduleType": "Weekly"
  }
}