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:

Operation Method URI Payload

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

Required: Yes

key-string

Description: Set key string (The key)

Type: string

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string