key key

Configure a key

key Specification

   
Type Collection
Object Key(s) key-number
Collection Name key-list
Collection URI /axapi/v3/key/{key-chain-flag}+{key-chain-name}/key
Element Name key
Element URI /axapi/v3/key/{key-chain-flag}+{key-chain-name}/key/{key-number}
Element Attributes key_attributes
Schema key schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/key/{key-chain-flag}+{key-chain-name}/key

key attributes

Create List

POST

/axapi/v3/key/{key-chain-flag}+{key-chain-name}/key

key attributes

Get Object

GET

/axapi/v3/key/{key-chain-flag}+{key-chain-name}/key/{key-number}

key attributes

Get List

GET

/axapi/v3/key/{key-chain-flag}+{key-chain-name}/key

key-list

Modify Object

POST

/axapi/v3/key/{key-chain-flag}+{key-chain-name}/key/{key-number}

key attributes

Replace Object

PUT

/axapi/v3/key/{key-chain-flag}+{key-chain-name}/key/{key-number}

key attributes

Replace List

PUT

/axapi/v3/key/{key-chain-flag}+{key-chain-name}/key

key-list

Delete Object

DELETE

/axapi/v3/key/{key-chain-flag}+{key-chain-name}/key/{key-number}

key attributes

key-list

key-list is JSON List of key attributes

key-list : [

]

key attributes

key-number

Description Key identifier number

Type: number

Range: 1-255

key-string

Description Set key string (The key)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters