Update install settings

2 minute read

POST https://caas.digicert.com/automationws/v1/automation/updateInstallSettings

Use this endpoint to update installation settings for a specific automation instance.

Example requests and responses

cURL

curl --location --request POST 'https://caas.digicert.com/automationws/v1/automation/updateInstallSettings' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": 5153184,
    "automationId": 301891,
    "divisionId": 677793,
    "installSettings": {
        "installationType": "AUTO_INSTALL_AFTER_APPROVAL",
        "isAlwaysOn": true,
        "autoRenewSettings": {
            "daysBeforeExpiry": 8,
            "scheduleTime": 1601994900000,
            "scheduleTimeZone": "5:30#chennai",
            "isAutoReplace": true
        }
    }
}'

200 OK

{
    "error": null,
    "data": "Successfully updated installation settings"
}

Request parameters

Name	Req/Opt	Type	Description
accountId	required	string	Account ID.
automationId	required	string	Automation ID.
divisionId	required	string	Division ID.
installSettings	required	object	Object with installation settings.
.. installationType	required	string	Certificate installation type. Certificate installation can either be on-demand or scheduled for a specific time.
.. isAlwaysOn	required	boolean	Whether to auto-renew and install certificates. If true, you must specify autoRenewSettings in your request. Default: false
.. scheduleTime	optional	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 Note: Required if the installationType is SCHEDULED_INSTALL.
.. scheduleTimeZone	optional	string	Time zone for the automation. Format: GMT + your timezone offset. Example: -8#pacifictime. Note: Required if the installationType is SCHEDULED_INSTALL.
.. autoRenewSettings	optional	object	Object with auto-renew settings.
.. .. daysBeforeExpiry	optional	integer	Number of days to renew the certificate before its expiration. Min: 1 day. Max: Less than the certificate validity.
.. .. scheduleTime	optional	integer	Time when automatic renewal starts on the specified relative day before the certificate’s expiration. Format: Number of seconds (0 (00:00:00) - 86399 (23:59:59)). Example: 82800 (23:00)
.. .. scheduleTimeZone	optional	string	Time zone for the auto-renew. Format: GMT + your timezone offset. Example:
-8#pacifictime
.. .. isAutoReplace	optional	boolean	For a revoked or missing certificates, `true` requests and installs the certificate. Default: false