Use this endpoint to view details about a specific automation instance.
curl --location --request POST 'https://caas.digicert.com/automationws/v1/automation/viewAutomationDetails' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"accountId": 5153184,
"automationId": 298577,
"divisionId": 677793
}'
{
"error": null,
"data": {
"autoStatusResponse": {
"automationStatus": "INSTALL_VALIDATION_FAILED",
"requestedOn": "1599716536705",
"installSettings": {
"installationType": "AUTO_INSTALL_AFTER_APPROVAL",
"isAlwaysOn": false
},
"userDetailsResponse": {
"firstName": "CertCentral",
"lastName": "Admin",
"container": {
"id": 677793,
"name": "Cert Testing Inc."
}
}
},
"autoOrderProgressResponse": {
"csrGenResponse": {
"csrProgress": "CSR_GENERATION_SUCCEEDED"
},
"certInstallResponse": {
"certInstallProgress": "INSTALL_VALIDATION_FAILED",
"causeOfFailure": "Post install validation is unsuccessful, could be due to installation failure / scan failure",
"solution": "Verify certificate manually on website and cancel this automation request if installed, otherwise retry. Contact customer support for additional help."
},
"isRetryApplicable": true
},
"certDetailsResponse": {
"commonName": "cert-testing.com",
"signatureHash": "",
"orgDetails": {
"name": "Cert Testing Inc.",
"address": "2801 N Thanksgiving Way",
"address2": "Suite 500",
"city": "Lehi",
"state": "Utah",
"telephone": "801-701-9600"
},
"sans": "",
"automationProfileName": "22jul2020 01",
"automationProfileId": 741.0,
"automationProfileStatus": "ACTIVE",
"productType": "SSL_SECURESITE_FLEX",
"validityPeriod": "1Y"
},
"isRequestApproval": false
}
}
Name | Req/Opt | Type | Description |
---|---|---|---|
accountId | required | string | Account ID. |
automationId | required | string | Automation ID. |
divisionId | required | string | Division ID. |
Name | Type | Description |
---|---|---|
error | object | Object with error details. |
data | object | Object with response data. |
.. autoStatusResponse | object | Object container for automation status details. |
.. .. automationStatus | string |
Status of the automation. Possible values: ACTION_REQUIRED , SUCCESFULLY_RENEWED , AUTO_RENEW_SCHEDULED , AUTOMATION_FAILED , AUTOMATION_SCHEDULED , CONFIGURED , INSTALL_VALIDATION_FAILED , INSTALL_FAILED , ERROR .
|
.. .. requestedOn | integer |
Request date and time of the automation. Format: epoch in milliseconds. An epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system. Example: 1596781119000
|
.. .. lastRunTime | integer | Date and time when the automation was last run. |
.. .. nextRenewalDate | integer | Date and time when the automation is scheduled for renewal. |
.. .. message | string | Message when agent or sensor is down and automation is already scheduled. |
.. .. installSettings | object | Object with installation settings. |
.. .. .. installationType | string |
Certificate installation type. Certificate installation can either be on-demand or scheduled for a specific time. AUTO_INSTALL_AFTER_APPROVAL : Install the certificate immediately after approval (on demand).SCHEDULED_INSTALL : Schedule the certificate installation for a later date/time.
|
.. .. .. isAlwaysOn | boolean |
Whether to auto-renew and install certificates. If true , you must specify autoRenewSettings in your request.Default: false
|
.. .. .. scheduleTime | integer |
Time when automation starts. Format: epoch in milliseconds. An epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system. Example: 1598299200000 *If you choose installationType as SCHEDULED_INSTALL .
|
.. .. .. scheduleTimeZone | string |
Time zone for the automation. Format: GMT + your timezone offset. Example: -8#pacifictime *If you choose installationType as SCHEDULED_INSTALL .
|
.. .. .. autoRenewSettings | object | Object with auto-renew settings. |
.. .. .. .. daysBeforeExpiry | integer |
Number of days to renew the certificate before certificate expiration. Min: 1 day Max: Less than the certificate validity. |
.. .. .. .. scheduleTime | integer |
Time when auto-renew starts. Format: epoch in milliseconds. An epoch corresponds to 0 hours, 0 minutes, and 0 seconds (00:00:00) Coordinated Universal Time (UTC) on a specific date, which varies from system to system. Example: 1596781119000
|
.. .. .. .. scheduleTimeZone | string |
Time zone for the auto-renew. Format: GMT + your timezone offset. Example: -8#pacifictime
|
.. .. .. .. isAutoReplace | boolean |
For a revoked or missing certificate, true requests and installs the certificate on the host.Default: false
|
.. .. userDetailsResponse | object | Object container for user details. |
.. .. .. firstName | string | First name of user that requested the automation. |
.. .. .. lastName | string | Last name of user that requested the automation. |
.. .. .. container | object | Primary container the user is attached to. |
.. .. .. .. id | integer | Container ID. |
.. .. .. .. name | string | Name of the container. |
.. autoOrderProgressResponse | object | Object container for the automation order progress. |
.. .. csrGenResponse | object | Object container for CSR generation details. |
.. .. .. csrProgress | string | CSR generation status. |
.. .. .. causeOfFailure | string | Message describing the cause of failure. |
.. .. .. solution | string | Solution message. |
.. .. postCsrGenResponse | object | Object container for post-CSR generation failure details. |
.. .. .. postCSRProgress | string | Status of post-CSR generation failure. |
.. .. .. causeOfFailure | string | Message describing the cause of failure. |
.. .. .. solution | string | Solution message. |
.. .. certInstallResponse | object | Object container for certificate installation details. |
.. .. .. certInstallProgress | string |
Status of certificate installation. Allowed values: AUTOMATION_SCHEDULED , CERT_READY_TO_INSTALL , INSTALL_IN_PROGRESS , INSTALL_FAILED , INSTALL_SUCCEEDED , INSTALL_VALIDATION_IN_PROGRESS , INSTALL_VALIDATION_FAILED , INSTALL_VALIDATED , AUTOMATION_FAILED .
|
.. .. .. scheduleOn | string |
Time when the certificate installation is scheduled. *If certInstallProgress status is AUTOMATION_SCHEDULED .
|
.. .. .. causeOfFailure | string | Message describing the cause of failure. |
.. .. .. solution | string | Solution message. |
.. .. isRetryApplicable | boolean |
Whether to retry the automation, if it fails. If true , retry is initiated.
|
.. certDetailsResponse | object | Object container for certificate details. |
.. .. commonName | string | Common name of the certificate. |
.. .. signatureHash | string |
Hash type ID for the algorithm used to sign the certificate. Allowed values: See Glossary-Hash types |
.. .. orgDetail | object | Object container for organization details. |
.. .. .. name | string | Name of the organization. |
.. .. .. address | string | Address of the organization. |
.. .. .. address2 | string | Continuation of the address. |
.. .. .. city | string | City where the organization is located. |
.. .. .. state | string | State where the organization is located. |
.. .. .. country | string | Country where the organization is located. |
.. .. .. telephone | string | Organization telephone number. |
.. .. sans | string | Comma-separated list of additional subject alternative names (SANs) to secure with automated certificate requests. |
.. .. automationProfileName | string | Name of the automation profile. |
.. .. automationProfileId | integer | Profile ID associated with the automation. |
.. .. automationProfileStatus | string |
Status of the automation profile. Allowed values: ACTIVE , ACTION_NEEDED .
|
.. .. productType | string |
Type of the product. Allowed values: See Glossary-Product identifiers. |
.. .. validityPeriod | string |
Certificate validity. Allowed values: 1D , 1Y End the string with D or Y .Example: 1Y Max value: 397 days |
.. isRequestApproval | boolean | Auto-approval of certificate request. |