Bulk retry automation

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

Use this endpoint to retry automating tasks in bulk when there is a failure. Fix issues that caused the initial automation request to fail before retrying.

For more information, see Certificates eligible for retry.

Example requests and responses

Retry an eligible or ineligible automation

Example 1. cURL

curl --location --request POST 'https://caas.digicert.com/automationws/v1/automation/bulkretryautomationtask' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "retryAutomationTaskRequests": [{
        "ip": "10.100.193.54",
        "port": 55085,
        "accountId": 5153184,
        "divisionId": 677793,
        "domainName": null,
        "agentLicenseKey": "58C5D9FD5BC95FAA"
    }, {
        "ip": "10.100.193.54",
        "port": 55084,
        "accountId": 5153184,
        "divisionId": 677793,
        "domainName": null,
        "agentLicenseKey": "58C5D9FD5BC95FAA"
    }, {
        "ip": "10.100.197.150",
        "managementIp": "10.100.192.246",
        "port": 1900,
        "accountId": 5153184,
        "divisionId": 677793,
        "domainName": null,
        "virtualServerName": "/Common/ManualDigi",
        "sensorLicenseKey": "2F88E69451FAE5C8"
    }],
    "accountId": 5153184
}'

Example 2. 200 OK

{
   "error": null,
    "data": {
        "retryMessages": {
            "10.100.193.54:55084": "Successfully initiated retry.",
            "10.100.193.54:55085": "Successfully initiated retry."
        },
        "failedRetries": {
            "10.100.197.150:1900": {
                "errors": [{
                    "errorCode": "1028",
                    "errorField": "10.100.197.150:1900",
                    "errorMessage": "Automated IP/Port is not eligible for retry."
                }],
                "status": {}
            }
        },
        "message": "2 of 3 automations submitted for retry.",
        "errors": [],
        "status": {}
    }
}

Retry all eligible automation

Example 3. cURL

curl --location --request POST 'https://caas.digicert.com/automationws/v1/automation/bulkretryautomationtask' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "retryAutomationTaskRequests": [{
        "ip": "10.100.193.54",
        "port": 55084,
        "accountId": 5153184,
        "divisionId": 677793,
        "domainName": null,
        "agentLicenseKey": "58C5D9FD5BC95FAA"
    }, {
        "ip": "10.100.193.54",
        "port": 55085,
        "accountId": 5153184,
        "divisionId": 677793,
        "domainName": null,
        "agentLicenseKey": "58C5D9FD5BC95FAA"
    }],
    "accountId": 5153184
}'

Retry all ineligible automation

Example 5. cURL

curl --location --request POST 'https://caas.digicert.com/automationws/v1/automation/bulkretryautomationtask' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "retryAutomationTaskRequests": [{
        "ip": "10.100.196.228",
        "managementIp": "10.100.192.227",
        "port": 30005,
        "accountId": 5153184,
        "divisionId": 677793,
        "domainName": null,
        "virtualServerName": "/Zpartition/Per5",
        "sensorLicenseKey": "D08D879E57304FFB"
    }, {
        "ip": "10.100.196.228",
        "managementIp": "10.100.192.227",
        "port": 30013,
        "accountId": 5153184,
        "divisionId": 677793,
        "domainName": null,
        "virtualServerName": "/partition1/per13",
        "sensorLicenseKey": "D08D879E57304FFB"
    }],
    "accountId": 5153184
}'

Example 6. 200 OK

{
   "error": null,
    "data": {
        "retryMessages": {},
        "failedRetries": {
            "10.100.196.228:30013": {
                "errors": [{
                    "errorCode": "1028",
                    "errorField": "10.100.196.228:30013",
                    "errorMessage": "Automated IP/Port is not eligible for retry."
                }],
                "status": {}
            },
            "10.100.196.228:30005": {
                "errors": [{
                    "errorCode": "1028",
                    "errorField": "10.100.196.228:30005",
                    "errorMessage": "Automated IP/Port is not eligible for retry."
                }],
                "status": {}
            }
        },
        "message": "0 of 2 automations submitted for retry.",
        "errors": [],
        "status": {}
    }
}

Request parameters

Name	Req/Opt	Type	Description
retryAutomationTaskRequests	required	object	Object container for retry automation details.
.. ip	required	integer	The port that you want to configure automation for.
.. port	required	integer	The port that you want to configure automation for.
accountId	required	string	Account ID.
divisionId	required	integer	Division ID.
.. domainName	optional^*	string	The domain name that you want to configure automation for. ^*Required only for SNI (having multiple profiles or certificates on same IP/Port) automation.
.. agentLicenseKey	optional^*	string	Agent license key. ^*Required for ACME automation agent flow.
.. virtualServerName	optional^*	string	Name of the virtual server to automate. ^Required for agentless automation flow. Note:* This parameter is not required for AWS load balancer.
.. sensorLicenseKey	optional^*	string	License key associated with the sensor. Note: *Only returned if `AGENTTYPE` is selected as `Agentless`

Response parameters

Name	Type	Description
error	object	Object with error details. Note: Returns null if there are no errors.
data	object	Object with response data.
.. retryMessages	object	Object container with retry information about the request.
.. failedRetries	object	Object container with failed retries about the request.
.. .. errors	array	List of objects with information about any errors that occurred while fetching the details.
.. .. .. errorField	string	The field that has error.
.. .. .. errorCode	string	Error code.
.. .. .. errorMessage	string	Error message.
.. message	string	Message with details about the retry task.
.. status	string	Status of the last check configuration request. Possible values:`Failed`, `In progress`.
.. errors	array	List of errors, if any.

In this section: