Request Structure
API: /certificate/reissue
Method: PUT
URL: https://<APPVIEWX_GATEWAY_IP>:<APPVIEWX_GATEWAY_PORT>/avxapi/certificate/reissue?gwkey=f000ca01&gwsource=external&isSync=true&ttl=300
| Name | Type | Mandatory | Field Type | Description | Constraints |
|---|---|---|---|---|---|
userName
|
Header | Yes |
String
|
Username that is configured in AppViewX. | NA |
password
|
Header | Yes |
String
|
Password of that user. | NA |
content-type
|
Header | Yes | String
|
Payload content-type with application/json value. | The value must be application/json. |
gwkey
|
Queryparam | Yes |
String
|
Tenant Key. This is needed only in case of multi tenant installations and can be ignored in other type of installations. | NA |
gwsource
|
Queryparam | Yes | String
|
Source, from which the request is triggered. For example, external. | NA |
isSync
|
Queryparam | No | boolean
|
The possible values are true and false. 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.
|
Must be a valid boolean value: true or false. |
ttl
|
Queryparam | No |
Int
|
Time to live for a response in seconds. Default value is 300 seconds. | Must be a positive integer. |
body
|
Body | Yes |
json
|
Refer to the sample request body. |
SyncReIssueRequest
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
resourceId
|
Yes | Mongo Id of the certificate in the AppViewX database. Note: It refers to the ‘resourceId’ field
in the create certificate response. It can be found using
the search API using commonName, serial No. or other search
parameters.
|
String
|
Either resourceId or serialNumber and commonName is mandatory. |
commonName
|
Yes | Common name of the certificate. |
String
|
|
serialNumber
|
Yes | Serial number of the certificate. |
String
|
|
reason
|
Yes | Reason for reissue. | String | |
uploadCsrDetails
|
No | Details of the CSR |
uploadCsrDetails
|
Refer to the uploadCsrDetails table. |
certificateFormat
|
Yes | Certificate download format details. |
certificateFormat
|
Refer to the certificateFormat table. |
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 |