Deleting a Master Key

Description

This API is used to delete a master key.

URL

DELETE https://ip:port/AIVAULT/v1/deleteMK/{MKName}

Request Header

Table 1 Request header

Parameter

Type

Description

DomainID

UInt

Key domain ID, which indicates the domain of an organization, an application, or a model. The value ranges from 1 to 500.

  1. Parameters in this request header are set by users.
  2. Domain IDs are used to differentiate applications or models. A maximum of 500 domains are supported.
  3. Deleting a master key is a high-risk operation. Before deleting a master key, the API caller needs to perform secondary identity authentication and adopt foolproof design to notify the user of risks.
  4. Before deleting a master key, delete other keys and data associated with the master key.

Request Parameter

Table 2 Request parameter

Parameter

Mandatory/Optional

Type

Description

MKName

Mandatory

String

The value of this parameter cannot be deleted in batches to prevent the master key from being deleted by mistake. Only one value can be deleted at a time. The value contains 1 to 128 characters, allowing only digits, letters, underscores (_), and hyphens (-).

Request Example

https://ip:port/AIVAULT/v1/deleteMK/test

Response Description

Table 3 Responses

Level-1 Parameter

Type

Description

status

String

Error code

msg

String

Error message

data

Object

Packet list

Response Example

{
    "status": "00000000",
    "msg": "ok",
    "data": null
}

For details about the error codes, see Error Codes.

For details about the status codes, see Status Codes.