Request Structure
URL: /certificate/pushToDevice
Type: POST
| 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. 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 |
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 |
|---|---|---|---|---|
certificateId
|
Yes | Resource id of the certificate. |
String
|
|
selectedProfiles
|
Yes | Server profile id. |
String
|
|
certificateDetails
|
Yes | Certificate details for the Server devices. |
Any of the following - |
NA |
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
locationType
|
Yes | Determines whether certificate has to be pushed into Certificate store or Centralized file system | String |
Allowed values
|
keyStoreLocation
|
Yes | If locationType Certificate store chosen, keyStoreLocation determines under which sub store the certificate has to be pushed |
String
|
Mandatory for locationType Certificate store Allowed values
|
certificateLocation
|
No | If locationType File system chosen, the actual folder location where pfx file has to be placed |
String
|
Applicable only if IIS is managed with Centralized file system If certificateLocation left blank, location specified during IIS device addition taken as location |
certificateFileName
|
Yes | Certificate friendly name with which certificate to be pushed into Certificate store / Certificate file name with which the certificate to be pushed into File system |
String
|
The certificate file name should not start and end with special characters except @, #, $, %, ^, &, _, {, }, [, ], |, :, <, >, (, ), ;, . |
bindType
|
No | Determines Update certificate binding only or Create new site binding or update site binding (port, hostname, SNI) |
String
|
Applicable for locationType Certificate store Allowed values
|
IsSNIEnabled
|
No | The Server Name Indication option to be mapped in IIS site binding |
Boolean (true or false)
|
Applicable when bindType is Update site binding or Create new site binging, Applicable for IIS versions >= 8.0 |
hostName
|
No | The hostname has to be updated in site binding |
String
|
Applicable when bindType is Update site binding or Create new site binging |
port
|
No | The port has to be updated in site binding |
String
|
Applicable when bindType is Update site binding or Create new site binging, Mandatory for bindType Create new site binding Allowed values between 1-65535 |
pushRootAndIntermediateCertificates
|
Yes | Root and Intermediate certificate also needs to be pushed or not |
Boolean (true or false)
|
Certificate details for
Microsoft PC Server
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
certificateType
|
Yes | The certificate format in which certificate has to be pushed |
String
|
Allowed values
|
certificateFileName
|
Yes | Certificate friendly name with which certificate to be pushed into Certificate store |
String
|
The certificate file name should not start and end with special characters except @, #, $, %, ^, &, _, {, }, [, ], |, :, <, >, (, ), ;, . |
pfxPassword
|
Yes | The temporary password used during certificate push |
String
|
The value has to be base64 encoded |
pushRootAndIntermediateCertificates
|
Yes | Root and Intermediate certificate also needs to be pushed or not |
Boolean (true or false)
|
NA |
Certificate details for
Microsoft Server
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
certificateType
|
Yes | The certificate format in which certificate has to be pushed |
String
|
Allowed values
|
pushLocation
|
Yes | The folder location in which certificate and private key has to be pushed |
String
|
NA |
certificateFileName
|
Yes | The file name of certificate |
String
|
Has to be suffixed with the format to be pushed. Ex: test.appviewx.com.pfx |
privateKeyFileName
|
Yes | The file name of private key |
String
|
Has to be suffixed with the format to be pushed. Ex: test.appviewx.com.key Applicable for types PEM-.crt, PEM-.cer, PEM-.pem, DER-.cer, DER-.der, PKCS7-.p7b, PKCS7-.p7c |
pfxPassword
|
No | The password of pfx/p12 file |
String
|
The value has to be base64 encoded Applicable for certificate types PKCS12-pfx,PKCS-p12 |
aliasName
|
No | The end entity certificate alias name for jks file |
String
|
Applicable for certificate type JKS-.jks |
keyStorePassword
|
No | The jks file password |
String
|
The value has to be base64 encoded Applicable for certificate type JKS-.jks |
privateKeyPassword
|
No | The private key entry password for jks file |
String
|
The value has to be base64 encoded Applicable for certificateType JKS-.jks |
pushRootAndIntermediateCertificates
|
Yes | Root and Intermediate certificate also needs to be pushed or not |
Boolean (true or false)
|
NA |
rootCertificateFileName
|
Yes | Certificate name in which name the root certificate to be pushed in a firewall device. |
String
|
CA file name should not start and end with special characters. No special characters except !, @, #, $, %, ^, &, _, {, }, [, ], |, :, <, >, (, ), ;, . and should not be the same as certificate file name and CA file name. |
intermediateCertificateFileName
|
Yes | Certificate name in which name the intermediate certificates to be pushed in a firewall device. |
List of Strings
|
Intermediate file names should not start and end with special characters. No special characters except !, @, #, $, %, ^, &, _, {, }, [, ], |, :, <, >, (, ), ;, . and should not be the same as certificate file name and CA file name. |
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
isManualPush
|
No | If selected, user can customize certificate and key push location |
Boolean (true or false)
|
NA |
certificateType
|
Yes | Certificate type in which format the certificate to be pushed in a server device. |
String
|
Possible Values: PEM-.crt PEM-.cer PEM-.pem |
certificateLocation
|
No. Mandatory if “isManualPush” is true | A user defined directory name in which the certificate will be pushed. |
String
|
NA |
certificateFileName
|
Yes | A user defined file name in which the certificate will be pushed into an Apache server. |
String
|
The certificate file name should not start and end with special characters except -, ., _. It should not be the same as CA file name and intermediate file name. |
keyLocation
|
No. Mandatory if “isManualPush” is true | A user defined key directory name in which the keys will be pushed into an Apache server |
String
|
NA |
privateKeyFileName
|
Yes | A user defined file name in which the keys will be pushed into an Apache server. |
String
|
The key file name should not start and end with special characters except -, ., _. Key file name should be same as certificateFileName |
isRestartRequired
|
No | Option to restart the service after push |
Boolean (true or false)
|
NA |
pushRootAndIntermediateCertificates
|
No | Root and Intermediate certificate also needs to be pushed or not |
Boolean (true or false)
|
NA |
trustLocation
|
No. Mandatory if “pushRootAndIntermediateCertificates” is true. | A user defined directory name in which the root and intermediate certificates will be pushed. |
String
|
NA |
rootCertificateFileName
|
No. Mandatory if “pushRootAndIntermediateCertificates” is true. | Certificate name in which name the root certificate to be pushed in a server device. |
String
|
Intermediate file or bundle name should not start and end with special characters. No special characters except (-, _, .) are allowed and should not be the same as the certificate file name |
intermediateCertificateFileName
|
No. Mandatory if “pushRootAndIntermediateCertificates” is true. | Certificate name in which name the intermediate certificates to be pushed in a server device. |
List of Strings
|
Should not start and end with special characters. No special characters except (-, _, .) are allowed and should not be the same as the certificate file name. |
privateKeyInDevice
|
No | If users need to push the private key in the device. |
Boolean (true or false)
|
NA |
Certificate details for
Tomcat Server
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
certificateType
|
Yes | Certificate type in which format the certificate to be pushed in a server device. |
String
|
Possible Values: PEM-.crt PEM-.cer PEM-.pem JKS-.jks |
certificateLocation
|
Yes | A user defined directory name in which the certificate will be pushed. |
String
|
NA |
certificateFileName
|
Yes | A user defined file name in which the certificate will be pushed into an Apache server. |
String
|
The certificate file name should not start and end with special characters except -, ., _. It should not be the same as CA file name and intermediate file name. |
keyLocation
|
Yes | A user defined key directory name in which the keys will be pushed into an Apache server |
String
|
NA |
privateKeyFileName
|
Yes | A user defined file name in which the keys will be pushed into an Apache server. |
String
|
The key file name should not start and end with special characters except -, ., _. Key file name should be same as certificateFileName |
keyStoreLocation
|
Yes | A user defined store location in which the keys and certificates will be pushed. |
String
|
Applicable for certificate type JKS-.jks. Enter the keystore location with the extension as .jks or .keystore |
keyStorePassword
|
Yes | The jks file password |
String
|
Applicable for certificate type JKS-.jks |
aliasName
|
No | The end entity certificate alias name for jks file |
String
|
Applicable for certificate type JKS-.jks |
privateKeyInDevice
|
No | If users need to push the private key in the device. |
|
Applicable for certificate type JKS-.jks |
privateKeyLocation
|
No. Mandatory if “privateKeyInDevice” is true. | A user defined directory name in which the private key will be pushed into the device. |
String
|
Applicable for certificate type JKS-.jks |
pushRootAndIntermediateCertificates
|
No | Root and Intermediate certificate also needs to be pushed or not |
Boolean (true or false)
|
Applicable for all certificate types. |
rootCertificateFileName
|
No. Mandatory if “pushRootAndIntermediateCertificates” is true. | Certificate name in which name the root certificate to be pushed in a server device. |
String
|
Intermediate file or bundle name should not start and end with special characters. No special characters except (-, _, .) are allowed and should not be the same as the certificate file name |
intermediateCertificateFileName
|
No. Mandatory if “pushRootAndIntermediateCertificates” is true. | Certificate name in which name the intermediate certificates to be pushed in a server device. |
List of Strings
|
Should not start and end with special characters. No special characters except (-, _, .) are allowed and should not be the same as the certificate file name. |
trustStoreLocation
|
No. Mandatory if “pushRootAndIntermediateCertificates” is true | A user defined store location in which the CA certificates will be pushed. |
String
|
Applicable for certificate type JKS-.jks. Provide the truststore location with the extension as .jks or .truststore |
trustStorePassword
|
No. Mandatory if “pushRootAndIntermediateCertificates” is true | The jks file password |
String
|
Applicable for certificate type JKS-.jks |
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
isManualPush
|
No | If selected, user can customize certificate and key push location |
Boolean (true or false)
|
NA |
certificateType
|
Yes | Certificate type in which format the certificate to be pushed in a server device. |
String
|
Possible Values: JKS-.jks PKCS12-.p12 |
keyStoreLocation
|
Yes | A user defined store location in which the keys and certificates will be pushed. |
String
|
Enter the keystore location with the extension as .jks or .keystore |
keyStorePassword
|
Yes | The jks file password |
String
|
Keystore password must have at least 6 characters. |
trustStoreLocation
|
No | A user defined store location in which the CA certificates will be pushed. |
String
|
Provide the truststore location with the extension as .jks or .truststore. Applicable only for certificate type JKS-.jks. |
trustStorePassword
|
No | The jks file password |
String
|
Truststore password must have at least 6 characters. Applicable only for certificate type JKS-.jks. |
privateKeyInDevice
|
No | If users need to push the private key in the device. |
Boolean (true or false)
|
NA |
keyLocation
|
No | A user-defined key directory name in which the keys will be pushed into an Apache server |
String
|
NA |
aliasName
|
No | The end entity certificate alias name for jks file |
String
|
NA |
Certificate details for
Weblogic Server
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
isManualPush
|
No | If selected, user can customize certificate and key push location |
Boolean (true or false)
|
NA |
certificateType
|
Yes | Certificate type in which format the certificate to be pushed in a server device. |
String
|
Possible Values: JKS-.jks |
keyStoreLocation
|
Yes | A user defined store location in which the keys and certificates will be pushed. |
String
|
Enter the keystore location with the extension as .jks or .keystore |
keyStorePassword
|
Yes | The jks file password |
String
|
Keystore password must have at least 6 characters. |
trustStoreLocation
|
Yes | A user defined store location in which the CA certificates will be pushed. |
String
|
Provide the truststore location with the extension as .jks or .truststore |
trustStorePassword
|
Yes | The jks file password |
String
|
Truststore password must have at least 6 characters. |
privateKeyInDevice
|
No | If users need to push the private key in the device. |
Boolean (true or false)
|
NA |
keyLocation
|
No | A user defined key directory name in which the keys will be pushed into an Apache server |
String
|
NA |
aliasName
|
No | The end entity certificate alias name for jks file |
String
|
NA |
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
isManualPush
|
No | If selected, user can customize certificate and key push location |
Boolean (true or false)
|
NA |
certificateType
|
Yes | Certificate type in which format the certificate to be pushed in a server device. |
String
|
Possible Values: PKCS12-.pfx |
dbPath
|
Yes | Database Location in server where certificates will be pushed. |
String
|
NA |
dbPassword
|
No | Password required to import certificates to database in server. |
String
|
NA |
isRestartRequired
|
No | Option to restart the service after push |
Boolean (true or false)
|
NA |
privateKeyInDevice
|
No | If users need to push the private key in the device. |
Boolean (true or false)
|
NA |
keyLocation
|
No | A user defined key directory name in which the keys will be pushed into an Apache server |
String
|
NA |
| Name | Mandatory | Description | Field Type | Constraints |
|---|---|---|---|---|
preValidationScriptPath
|
No | Location of the pre push script. |
String
|
NA |
postValidationScriptPath
|
No | Location of the post push script. |
String
|
NA |
overwrite
|
No | Whether the certificate needs to be overwritten if already available. | Boolean (true or false) |
Enabled by default for IIS vendor. |
pushAutomatically
|
No | Whether the certificate needs to be pushed automatically when renewed. | Boolean (true or false) |