Request Structure
API : /certificate/create
Type: POST
URL: https://<APPVIEWX_GATEWAY_IP>:<APPVIEWX_GATEWAY_PORT>/avxapi/certificate/create?gwkey=f000ca01&gwsource=external&isSync=true&ttl=300
| Name | Param Type | Description | Field Type | Constraints |
|---|---|---|---|---|
sessionId
|
Header | Session Id received after login |
String
|
Required if username and password are not provided |
username
|
Header | AppViewX login username |
String
|
Required if sessionId is not provided |
password
|
Header | AppViewX login password |
String
|
Required if sessionId is not provided |
Content-Type
|
Header | Specifies the nature of the data in the payload. |
String
|
Value of the param should be ‘application/json’ |
gwkey
|
Query |
Tenant Key. This is needed only in case of multi tenant installations and can be ignored in other type of installations.
|
String
|
NA |
gwsource
|
Query | Source from which the request is triggered(E.g. external). |
String
|
NA |
isSync
|
Query |
If you want to use sync API, set the value as true. If you want to use the async API, set the value as false. Note: Default value is false . |
Boolean
|
Must be a valid boolean value : true/false. |
ttl
|
Query |
Time to live for a response in seconds. Default value is 300 seconds. |
Integer
|
Must be a positive integer. |
Payload
|
Body | Contains all the params to be sent in the request body for the post request |
SyncRequestStructure
|
NA |
SyncRequestStructure
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
csrGenerationSource
|
No | Specifies where the CSR is to be generated. |
String
|
Possible values: appviewx, HSM, ENDPOINT, uploadCSR Default value: appviewx |
caConnectorInfo
|
Yes | Details related to Certificate Authority and CSR Parameters |
Any of the following -
|
|
certificateGroup
|
No | Specifies the group under which the created certificate needs to be tagged. | certificateGroup |
Default certificateGroup: Default |
deviceDetails
|
No | Details on the device/endpoint in which CSR will be generated | deviceDetails | Required if the csrGenerationSource is ENDPOINT |
certificateHSMDetails
|
No | Details on the Hardware Security Module (HSM) device | certificateHSMDetails | Required if the csrGenerationSource is HSM |
uploadCsrDetails
|
No | Details on the CSR | uploadCsrDetails | Required if the csrGenerationSource is uploadCSR |
certificateFormat
|
No | Certificate download format details. | certificateFormat |
certificateGroup
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
name
|
No | Specifies the group under which the created certificate needs to be tagged. |
String
|
Group must already be present in AppViewX |
deviceDetails
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
category
|
Yes | Specifies the device category |
String
|
Possible values: ADC, Server, Firewall |
vendor
|
Yes | Vendor for the chosen device. For example, Apache is a vendor for Server category |
String
|
NA |
deviceName
|
Yes | Name of the device as per AppViewX Device Inventory |
String
|
NA |
csrFileName
|
Yes | Name of the CSR file that will be generated in the device |
String
|
NA |
keyFileName
|
Yes | Name of the Key file that will be generated in the device |
String
|
NA |
attributes
|
No | Additional attributes related to device |
attributes
|
NA |
attributes
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
csrLocation
|
No | Location in the device where CSR will be created |
String
|
Required if deviceDetails.category - Server and deviceDetails.vendor - Tomcat |
tenant
|
No | Name of the partition in the AVI device |
String
|
NA |
partition
|
No | Name of the partition in the device |
String
|
Required if deviceDetails.category - Firewall and deviceDetails.vendor - Fortinet |
certificateHSMDetails
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
type
|
Yes | Type of the HSM device |
String
|
Possible values: ADC, hsm |
keyReference
|
Yes | Reference name for the key that will be mapped by the HSM device. |
String
|
NA |
hsmSettings
|
Yes | Configuration details for the HSM device |
hsmSettings
|
NA |
vendor
|
Yes | Vendor for the chosen device. For example, F5. |
String
|
NA |
deviceName
|
Yes | Name of the device as per AppViewX Device Inventory |
String
|
NA |
hsmSettings
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
vendorType
|
Yes | Category of the vendor |
String
|
Possible values: Safenet, Thales, Fortanix |
vendorSpecificSettings
|
Yes | Settings related to HSM vendor |
HSM
vendorSpecificSettings
|
NA |
HSM
vendorSpecificSettings
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
moduleId
|
No | Module Id |
String
|
Applicable if hsmSettings.vendorType is Thales |
uploadCsrDetails
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
category
|
Yes | Certificate category |
String
|
Possible values - Server, Client, Code Signing |
csrContent
|
Yes | The CSR content for certificate enrollment request |
String
|
NA |
certificateFormat
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
format
|
Yes | Certificate download format. |
String
|
Refer to the Possible values for Certificate Download Format |
password
|
Yes | The field is mandatory for some parameters. |
String
|
NA |
Possible values for
Certificate Download Format
| Certificate Extension | Value to be provided in payload | Password Required |
|---|---|---|
| .crt | CRT | No |
| .cert | CERT | No |
| .cer | CER | No |
| .pem | PEM | No |
| .der | DER | No |
| .cer | DERCER | No |
| .p7b | P7B | No |
| .p7c | P7C | No |
| .pk8 | PK8 | No |
| .p12 | P12 | Yes |
| .pfx | PFX | Yes |
| .jks | JKS | Yes |