web-service secure¶
Web-service secure operation
secure Specification¶
Parameter Value Type operational Element Name secure Element URI /axapi/v3/web-service/secure Element Attributes secure_attributes Partition Visibility shared Schema secure schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
EXECUTE Object | POST | /axapi/v3/web-service/secure |
secure attributes¶
certificate
Description: certificate is a JSON Block. Please see below for certificate
Type: Object
Reference Object: /axapi/v3/web-service/secure/certificate
generate
Description: generate is a JSON Block. Please see below for generate
Type: Object
Reference Object: /axapi/v3/web-service/secure/generate
private-key
Description: private-key is a JSON Block. Please see below for private-key
Type: Object
Reference Object: /axapi/v3/web-service/secure/private-key
regenerate
Description: regenerate is a JSON Block. Please see below for regenerate
Type: Object
Reference Object: /axapi/v3/web-service/secure/regenerate
restart
Description Restart WEB service
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
wipe
Description Wipe WEB private-key and certificate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
certificate¶
Specification Value Type object file-url
Description File URL
Type: string
Format: url
load
Description Load WEB certificate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
regenerate¶
Specification Value Type object country
Description The country name
Type: string
Maximum Length: 2 characters
Maximum Length: 2 characters
domain-name
Description The domain name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
state
Description The location
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
generate¶
Specification Value Type object country
Description The country name
Type: string
Maximum Length: 2 characters
Maximum Length: 2 characters
domain-name
Description The domain name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
state
Description The location
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
private-key¶
Specification Value Type object file-url
Description File URL
Type: string
Format: url
load
Description Load WEB private-key
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0