Deleting a Pre-Shared Key

Description

The API is used to delete a pre-shared key.

URL

DELETE https://ip: port/AIVAULT/v1/deletePSK/{PSKName}

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 pre-shared key is a high-risk operation. Before deleting a pre-shared key, the API caller needs to perform secondary identity authentication and adopt foolproof design to notify the user of risks.

Request Parameter

Table 2 Request parameter

Parameter

Mandatory/Optional

Type

Description

PSKName

Mandatory

String

Values of this parameter cannot be deleted in batches to prevent users from deleting the pre-shared key 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/deletePSK/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.