---
title: "Update database cluster restore"
method: PUT
path: "/namespaces/{namespace}/database-cluster-restores/{name}"
tags: ["Restore"]
---

# Update database cluster restore

`PUT /namespaces/{namespace}/database-cluster-restores/{name}`

This API updates the database cluster restore specified by the `name` and `namespace`.

## Path parameters

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

## Request body

- DatabaseClusterRestore — DatabaseClusterRestore is the Schema for the databaseclusterrestores API.
  - `apiVersion` string — APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  - `kind` string — Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  - `metadata` object
  - `spec` object — DatabaseClusterRestoreSpec defines the desired state of DatabaseClusterRestore.
    - `dataSource` object, required — DataSource defines a data source for restoration.
      - `backupSource` object — BackupSource is the backup source to restore from. Shall be set either this field or DBClusterBackupName.
        - `backupStorageName` string, required — BackupStorageName is the name of the BackupStorage used for storing backups. The BackupStorage must be created in the same namespace as the DatabaseCluster.
        - `path` string, required — Path is the path to the backup file/directory.
      - `dbClusterBackupName` string — DBClusterBackupName is the name of the DB cluster backup to restore from. Shall be set either this field or BackupSource.
      - `pitr` object — PITR is the point-in-time recovery configuration. May be set in addition to DBClusterBackupName or BackupSource to perform PITR restore.
        - `date` string — Date is the UTC date to recover to. The accepted format: "2006-01-02T15:04:05Z".
        - `type` 'date' | 'latest' — Type is the type of recovery.
    - `dbClusterName` string, required — DBClusterName defines the target database cluster name that needs to be restored from backup.
  - `status` object — DatabaseClusterRestoreStatus defines the observed state of DatabaseClusterRestore.
    - `completed` string, date-time
    - `inUse` boolean — InUse is a flag that indicates if this restore resource is being used to restore DB cluster from backup.
    - `message` string
    - `state` string — RestoreState represents state of restoration.

## Response `200`

Successful operation

- DatabaseClusterRestore — DatabaseClusterRestore is the Schema for the databaseclusterrestores API.
  - `apiVersion` string — APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  - `kind` string — Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  - `metadata` object
  - `spec` object — DatabaseClusterRestoreSpec defines the desired state of DatabaseClusterRestore.
    - `dataSource` object, required — DataSource defines a data source for restoration.
      - `backupSource` object — BackupSource is the backup source to restore from. Shall be set either this field or DBClusterBackupName.
        - `backupStorageName` string, required — BackupStorageName is the name of the BackupStorage used for storing backups. The BackupStorage must be created in the same namespace as the DatabaseCluster.
        - `path` string, required — Path is the path to the backup file/directory.
      - `dbClusterBackupName` string — DBClusterBackupName is the name of the DB cluster backup to restore from. Shall be set either this field or BackupSource.
      - `pitr` object — PITR is the point-in-time recovery configuration. May be set in addition to DBClusterBackupName or BackupSource to perform PITR restore.
        - `date` string — Date is the UTC date to recover to. The accepted format: "2006-01-02T15:04:05Z".
        - `type` 'date' | 'latest' — Type is the type of recovery.
    - `dbClusterName` string, required — DBClusterName defines the target database cluster name that needs to be restored from backup.
  - `status` object — DatabaseClusterRestoreStatus defines the observed state of DatabaseClusterRestore.
    - `completed` string, date-time
    - `inUse` boolean — InUse is a flag that indicates if this restore resource is being used to restore DB cluster from backup.
    - `message` string
    - `state` string — RestoreState represents state of restoration.

## Other responses

- `201` — Created successful
- `400` — Unsuccessful operation
- `500` — Internal server error

---

[API](https://skmtc.net/openeverest/apis/openeverest-schema.md) · [All operations](https://skmtc.net/openeverest/apis/openeverest-schema/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openeverest/openeverest-schema/versions/46b19e13670b/schema)
