Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Backup Management/ Enabling or Disabling Encrypted Backup
Updated on 2025-11-14 GMT+08:00
View PDF

Enabling or Disabling Encrypted Backup

Function

This API is used to enable or disable encrypted backup. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/backups/encryption

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

encryption_status

Yes

String

Definition

Whether to enable or disable encrypted backup. The value is case insensitive.

Constraints

N/A

Range

  • on: Encrypted backup is enabled.

  • off: Encrypted backup is disabled.

Default Value

N/A

type

No

String

Definition

Encryption type.

Constraints

Currently, only kms (case-insensitive) is supported.

This parameter is mandatory when encrypted backup is enabled and is not required when encrypted backup is disabled.

Range

kms

Default Value

N/A

kms_key_id

No

String

Definition

KMS ID. This parameter is mandatory when encrypted backup is enabled and is not required when encrypted backup is disabled.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

encryption_status

String

Definition

Whether encrypted backup is enabled.

Range

  • on: Encrypted backup is enabled.

  • off: Encrypted backup is disabled.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

  • Enabling encrypted backup 
    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption
{
  "type" : "kms",
  "kms_key_id" : "b82fa43f-f6e8-4ec4-9c31-231bc547c526",
  "encryption_status" : "on"
}
  • Disabling encrypted backup 
    POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/backups/encryption
{
  "encryption_status" : "off"
}

Example Response

Status code: 200

Success.

{
  "encryption_status" : "on"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management