Request Structure

URL: /certificate/action

Type: PUT

Name 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 String NA
gwsource Query Source from which the request is triggered String NA
Payload Body Contains all the params to be sent in the request body for the post request Payload NA
Payload
Name Mandatory Description Field Type Constraints
resourceId No

Unique Id of the certificate .

Note:resourceId in the above request can be found using the search API using commonName, serial No. or other search parameters.

String Required if the commonName and serialNumber are not specified.
commonName No Common name of the certificate String Required if resourceId is not specified.
serialNumber No Serial number of the certificate String Required if resourceId is not specified.
action Yes Action name for the renewal String Value should be Renew
challengePassword No Base64 encoded value of challenge password String Applicable and mandatory for Symantec Certificate Authority
uploadCsrDetails No CSR details of the new certificate uploadCsrDetails If specified the CSR generation source will be uploadCsrDetails. The default CSR generation source is appviewx.
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