pki¶
PKI Commands
pki Specification¶
Parameter Value Type Intermediate Resource Element Name pki Element URI /axapi/v3/pki Element Attributes pki_attributes Partition Visibility None Schema pki schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/pki | pki_attributes |
pki attributes¶
copy-cert
Description: copy-cert is a JSON Block. Please see below for copy-cert
Type: Object
Reference Object: /axapi/v3/pki/copy-cert
copy-key
Description: copy-key is a JSON Block. Please see below for copy-key
Type: Object
Reference Object: /axapi/v3/pki/copy-key
create-oper
Description: create-oper is a JSON Block. Please see below for create-oper
Type: Object
Reference Object: /axapi/v3/pki/create-oper
delete
Description: delete is a JSON Block. Please see below for delete
Type: Object
Reference Object: /axapi/v3/pki/delete
delete-oper
Description: delete-oper is a JSON Block. Please see below for delete-oper
Type: Object
Reference Object: /axapi/v3/pki/delete-oper
ssl-ca-cert
Description: ssl-ca-cert is a JSON Block. Please see below for ssl-ca-cert
Type: Object
Reference Object: /axapi/v3/pki/ssl-ca-cert
ssl-cert
Description: ssl-cert is a JSON Block. Please see below for ssl-cert
Type: Object
Reference Object: /axapi/v3/pki/ssl-cert
delete-oper¶
Specification Value Type object filename
Description
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
copy-key¶
Specification Value Type object dest-key
Description Destination key file
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
overwrite
Description Overwrite the destination file if already present
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rotation
Description Specify rotation number of SCEP generated key file
Type: number
Range: 1-4
src-key
Description Source key file
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
copy-cert¶
Specification Value Type object dest-cert
Description Destination certificate file
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
overwrite
Description Overwrite the destination file if already present
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rotation
Description Specify rotation number of SCEP generated certificate file
Type: number
Range: 1-4
src-cert
Description Source certificate file
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
ssl-ca-cert¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
create-oper¶
Specification Value Type object bits
Description ‘1024’: 1024; ‘2048’: 2048; ‘4096’: 4096;
Type: string
Supported Values: 1024, 2048, 4096
Default: 1024
common-name
Description
Type: string
Format: string-rlx
Maximum Length: 64 characters
Maximum Length: 1 characters
country
Description
Type: string
Maximum Length: 3 characters
Maximum Length: 2 characters
csr-generate
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
division
Description
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Description
Type: string
Format: email-addr
Maximum Length: 64 characters
Maximum Length: 1 characters
filename
Description
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
locality
Description
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
organization
Description
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
state-province
Description
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
valid-days
Description
Type: number
Range: 30-3650
Default: 730
ssl-cert¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
delete¶
Specification Value Type object ca
Description CA certificate file name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
cert-name
Description Certificate file name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
crl
Description CRL file name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
private-key
Description Private key file name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters