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:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/ntp/auth-key

auth-key attributes

Create List

POST

/axapi/v3/ntp/auth-key

auth-key attributes

Get Object

GET

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

auth-key attributes

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

Replace List

PUT

/axapi/v3/ntp/auth-key

auth-key-list

Delete Object

DELETE

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

auth-key attributes

auth-key-list

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

auth-key-list : [

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