key

Configure a key chain for use by RIP or IS-IS MD5 authentication.

key Specification

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

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/key/

key Attributes

Create List

POST

/axapi/v3/key/

key Attributes

Get Object

GET

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

key Attributes

Get List

GET

/axapi/v3/key/

key-list

Modify Object

POST

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

key Attributes

Replace Object

PUT

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

key Attributes

Replace List

PUT

/axapi/v3/key/

key-list

Delete Object

DELETE

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

key Attributes

key-list

key-list is JSON List of key Attributes

key-list : [

key Attributes

key-chain-flag

Description: Key-chain management

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Required: Yes

key-chain-name

Description: Key-chain name

Type: string

Required: Yes

key-list

Description: key-list is a JSON List . Please see below for key-list

Type: List

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

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

key-list

Specification
Type list
Block object keys

key-number

Description: Key identifier number

Type: number

Range: 1-255

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