ntp auth-key¶

authentication key

auth-key Specification¶

Parameter Value

Type Collection

Object Key(s) key

Collection Name auth-key-list

Collection URI /axapi/v3/ntp/auth-key

Element Name auth-key

Element URI /axapi/v3/ntp/auth-key/{key}

Element Attributes auth-key_attributes

Partition Visibility shared

Schema auth-key schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ntp/auth-key	auth-key attributes
POST /axapi/v3/ntp/auth-key/ Payload: { "auth-key": { "key-type": "ascii", "alg-type": "M", "key": 1, "asc-key": "a" } }
Create List	POST	/axapi/v3/ntp/auth-key	auth-key attributes
Get Object	GET	/axapi/v3/ntp/auth-key/{key}	auth-key attributes
GET /axapi/v3/ntp/auth-key/1 Reponse: { "auth-key": { "key": 1, "alg-type": "M", "key-type": "ascii", "encrypted": "zP0indQxzdAJq8YO18jgWLD4x0ZDiMM7cG/+qyDtm5Ma/AhJOrbLAgl65Lk+4I2H", "uuid": "e6662d6c-5100-11ee-a47e-3b140db7f68c", "a10-url": "/axapi/v3/ntp/auth-key/1" } }
Get List	GET	/axapi/v3/ntp/auth-key	auth-key-list
Modify Object	POST	/axapi/v3/ntp/auth-key/{key}	auth-key attributes
Replace Object	PUT	/axapi/v3/ntp/auth-key/{key}	auth-key attributes
PUT /axapi/v3/ntp/auth-key/1 Payload: { "auth-key": { "key-type": "hex", "alg-type": "SHA", "key": 1, "hex-key": "aaaaaaaaaaaaaaaaaaaab" } }
Replace List	PUT	/axapi/v3/ntp/auth-key	auth-key-list
Delete Object	DELETE	/axapi/v3/ntp/auth-key/{key}	auth-key attributes
DELETE /axapi/v3/ntp/auth-key/1 Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

auth-key-list¶

auth-key-list is JSON List of auth-key attributes

auth-key-list : [

{ auth-key attributes },

{ auth-key attributes },

…

]

auth-key attributes¶

alg-type

Description ‘M’: encryption using MD5; ‘SHA’: encryption using SHA; ‘SHA1’: encryption using SHA1;

Type: string

Supported Values: M, SHA, SHA1

asc-key

Description

Type: string

Format: password

Maximum Length: 20 characters

Maximum Length: 1 characters

Mutual Exclusion: asc-key and hex-key are mutually exclusive

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

Mutual Exclusion: encrypted and hex-encrypted are mutually exclusive

hex-encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

Mutual Exclusion: hex-encrypted and encrypted are mutually exclusive

hex-key

Description

Type: string

Format: password

Maximum Length: 40 characters

Maximum Length: 21 characters

Mutual Exclusion: hex-key and asc-key are mutually exclusive

key

Description authentication key

Type: number

Range: 1-65535

key-type

Description ‘ascii’: key string in ASCII form; ‘hex’: key string in hex form;

Type: string

Supported Values: ascii, hex

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters