---
title: "Update backup policy of specific tenant"
method: PATCH
path: "/api/v1/obtenants/{namespace}/{name}/backupPolicy"
tags: ["Obtenant"]
---

# Update backup policy of specific tenant

`PATCH /api/v1/obtenants/{namespace}/{name}/backupPolicy`

Update backup policy of specific tenant

## Path parameters

- `namespace` string, required
- `name` string, required

## Request body

- ParamUpdateBackupPolicy
  - `jobKeepWindow` integer
  - `pieceInterval` integer
  - `recoveryWindow` integer
  - `scheduleDates` ParamScheduleDate[]
    - `backupType` string, required — Enum: Full, Incremental
    - `day` integer, required — Description: 1-31 for monthly, 1-7 for weekly
  - `scheduleTime` string — Description: HH:MM Example: 04:00
  - `scheduleType` string — Enum: Weekly, Monthly
  - `status` string — Enum: PAUSED, RUNNING

## Response `200`

OK

- object
  - `data` ResponseBackupPolicy
    - `archivePath` string, required
    - `bakDataPath` string, required
    - `bakEncryptionSecret` string
    - `destType` string, required — Enum: NFS, OSS
    - `jobKeepDays` integer
    - `name` string
    - `namespace` string
    - `ossAccessSecret` string
    - `pieceIntervalDays` integer
    - `recoveryDays` integer
    - `scheduleDates` ParamScheduleDate[]
      - `backupType` string, required — Enum: Full, Incremental
      - `day` integer, required — Description: 1-31 for monthly, 1-7 for weekly
    - `scheduleTime` string — Description: HH:MM Example: 04:00
    - `scheduleType` string — Enum: Weekly, Monthly
    - `status` string
    - `tenantName` string
  - `message` string
  - `successful` boolean

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

## Changes

- **2024-02-27** `643ae3c8d824` — 2 info
  - api tag `Obtenant` added
  - api tag `OBTenant` removed

[Change history](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/changes/api/v1/obtenants/:namespace/:name/backupPolicy/patch.md)

---

[API](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api.md) · [All operations](https://skmtc.dev/oceanbase/apis/oceanbase-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/oceanbase/oceanbase-dashboard-api/revisions/643ae3c8d824/schema)