Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Tenant/ Modifying the Repository Encryption Configurations of the Current Tenant
Updated on 2026-05-12 GMT+08:00
View PDF
Share

Modifying the Repository Encryption Configurations of the Current Tenant

Function

This API is used to modify the repository encryption configurations of the current tenant.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

No identity policy-based permission required for calling this API.

URI

PUT https://{hostURL}/v4/tenants/{tenant_id}/repo-encryption/setting

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

tenant_id

Yes

String

Definition

Tenant ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

A string that can contain 1 to 100,000 characters.

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tenant_id

No

String

Definition

Tenant ID.

Range

The value must contain 1 to 1,000 characters.

encryption_type

No

String

Definition

Encryption type

Range
  • KMS indicates whether KMS encryption is enabled.
  • Normal indicates that KMS encryption is not enabled.

default_encryption_enabled

No

Boolean

Definition

Whether to enable the default encryption settings under the tenant.

cmk_key_name

No

String

Definition

Name of the encryption master key.

Range

The value must contain 1 to 1,000 characters.

cmk_key_id

No

String

Definition

ID of the encryption master key.

Range

The value must contain 1 to 1,000 characters.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

tenant_id

String

Definition

Tenant ID.

Range

The value must contain 1 to 1,000 characters.

encryption_type

String

Definition

Encryption type

Range
  • KMS indicates whether KMS encryption is enabled.
  • Normal indicates that KMS encryption is not enabled.

default_encryption_enabled

Boolean

Definition

Whether to enable the default encryption settings under the tenant.

cmk_key_name

String

Definition

Name of the encryption master key.

Range

The value must contain 1 to 1,000 characters.

cmk_key_id

String

Definition

ID of the encryption master key.

Range

The value must contain 1 to 1,000 characters.

id

Integer

Definition

Record ID.

Value range:

1~2147483647

key_state

Integer

Definition

Status of the encryption master key.

Range

1: To-be-activated. 2: Enabled. 3: Disabled. 4: Pending deletion. 5: Pending import.

Enumeration values:

  • 1

  • 2

  • 3

  • 4

  • 5

region

String

Definition

Current region.

Range

The value must contain 1 to 1,000 characters.

region_type

String

Definition

Region type.

Range

The value must contain 1 to 1,000 characters.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

PUT https://{endpoint}/v4/tenants/{tenant_id}/repo-encryption/setting

{
  "cmk_key_id" : "7308c1b8-557f-453a-aef7-28643f49cf1e",
  "cmk_key_name" : "test111",
  "default_encryption_enabled" : true,
  "encryption_type" : "KMS",
  "tenant_id" : "159b65b41ead484d8ddff250a4731781"
}

Example Responses

Status code: 200

OK

{
  "id" : 8,
  "tenant_id" : "159b65b41ead484d8ddff250a4731781",
  "encryption_type" : "KMS",
  "default_encryption_enabled" : false,
  "cmk_key_name" : "test111",
  "cmk_key_id" : "7308c1b8-557f-453a-aef7-28643f49cf1e",
  "key_state" : 2,
  "region" : "cn-north-7",
  "region_type" : "primary"
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: Tenant