Updated on 2026-09-21 GMT+08:00

Disabling a Dedicated Keystore

Function

This API is used to disable a dedicated keystore.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/keystores/{keystore_id}/disable

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

The value returned by the IAM API is used, which contains 32 characters.

Default Value

N/A

keystore_id

Yes

String

Definition

Keystore ID

Constraints

The value must match the regular expression [0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$.

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

keystore

KeyStoreStateInfo object

Definition

Keystore status

Range

N/A

Table 4 KeyStoreStateInfo

Parameter

Type

Description

keystore_id

String

Definition

Keystore ID

Range

N/A

keystore_state

String

Definition

Keystore status

Range

N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "keystore" : {
    "keystore_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "keystore_state" : "3"
  }
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.