Get automation IPs list

  4 minute read  

POST https://caas.digicert.com/automationws/v1/automatedips/list
Use this endpoint to get a list of details about your automated IPs.

This endpoint returns information about:

  • Certificates expiring in 90 days or less so you can schedule them for automation.
  • Status of scheduled automation requests.
  • Automation and agent errors.

Example requests and responses

cURL

curl --location --request POST 'https://caas.digicert.com/automationws/v1/automatedips/list' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": 5153184,
    "searchCriteriaList": [
        {
            "key": "AUTOMATION_STATUS",
            "operation": "EQUALS",
            "value": [
                "SUCCESSFULLY_RENEWED"
            ]
        },
        {
            "key": "AGENT_NAME",
            "operation": "EQUALS",
            "value": [
                "10.100.192.228"
            ]
        }
    ],
    "divisionIds": [
        677793
    ],
    "pageSize": 50,
    "startIndex": 1,
    "sorting": {
        "commonName": "DESC"
    }
}'

200 OK

{
    "error": null,
    "data": {
        "automatedIps": [
            {
                "appInfo": {
                    "name": "A10",
                    "version": "2.7.2-P7-SP3",
                },
                "appPartition": "/shared",
                "alias": "10.100.198.228_HTTPS_2012",
                "automationId": 299171,
                "automatedIp": "10.100.198.228",
                "automatedPort": 2012,
                "managementIp": "10.100.192.228",
                "agentName": "10.100.192.228",
                "automationStatus": "SUCCESSFULLY_RENEWED",
                "certificateCn": "31Aug.cert-testing.com",
                "certificateExpiresOn": 15995664E12,
                "certificateId": "6f8f128f8cec54b3daff5b95888c4aa516598072",
                "certificateSerialNumber": "045251e7ffd49ec34d48cd911165fe62",
                "certProductType": "ssl_securesite_pro",
                "agentId": 1985,
                "certificateCa": "DigiCert",
                "divisionId": 677793,
                "newCertOrderId": 9013451,
                "newCertCn": "31Aug.cert-testing.com",
                "profileId": 726,
                "profileName": "9thJuly",
                "sensorName": "LatestSensorUpgrade3818",
                "sensorLicenseKey": "9A553B6AD7812E96",
                "actions": [
                    {
                        "actionType": "primary",
                        "action": [
                            "renew"
                        ]
                    },
                    {
                        "actionType": "secondary",
                        "action": [
                            "replace"
                        ]
                    }
                ]
            }
        ],
        "totalCount": 1,
        "totalPages": 1
    }
}

Request parameters

NameReq/OptTypeDescription
accountIdrequiredstringAccount ID.
searchCriteriaListoptionalarrayFilter results by specified values.
Example:
.. keyoptionalstringField name (key) to search.
Allowed values: PROFILE_TYPE , LB_DATA_PORT, AUTOMATION_STATUS, LB_DATA_IP, CA, AGENT_NAME.
.. operationoptionalstringFilter operation.
Allowed values:EQUALS.
.. valueoptionalarrayList of values to filter against.
divisionIdsrequiredarrayDivision IDs.
pageSizeoptionalintegerNumber of records per page.
Allowed values: 0 to 512
Default: 50
startIndexoptionalintegerIndex of the first result.
Default: 1.
sortingoptionalobjectSorting details.
An object with key/value pairs that describe how to sort the results. Each key is the name of a field that you can use for sorting. Each value describes whether to sort in ascending ASC or descending DESCorder.
Allowed keys: commonName, automatedIp, automatedPort, ca, agentName, automationAgentAppName, automationStatus.
Allowed values: DESC (descending: 9-0, Z-A), ASC (ascending: 0-9, A-Z)
Examples:
filterSelectedoptionalstringName of the filter selected.

Response parameters

NameTypeDescription
errorobjectObject with error details.
dataobjectObject with response data.
.. automatedIpsarrayList of objects with details about the results.
.. .. appInfoobjectObject with details about the application.
.. .. .. namestringName of the application.
.. .. .. versionstringApplication version.
.. appPartitionstringThe partition to which the data IP belongs.
.. .. automationIdintegerAutomation ID.
.. .. automatedIpstringIP that is automated.
.. .. automatedPortintegerPort that is automated.
.. .. managementIpstringManagement IP. For more information, see Sensor automation on F5 load balancer.
.. .. agentNamestringName of the agent.
.. .. automationStatusstringStatus of the automation. Possible values: ACTION_REQUIRED, SUCCESFULLY_RENEWED, AUTO_RENEW_SCHEDULED, AUTOMATION_FAILED, AUTOMATION_SCHEDULED, CONFIGURED, INSTALL_VALIDATION_FAILED, INSTALL_FAILED, ERROR.
.. .. certificateCnstringCommon name of the certificate.
.. .. certificateExpiresOnintegerExpiration date of the certificate. Format: epoch in milliseconds. Example: 1596781119
.. .. certificateIdstringID of the CA certificate that signs the certificate.
.. .. certificateSerialNumberstringSerial number of the certificate.
.. .. certProductTypestringProduct ID for the certificate.
.. .. agentIdintegerID of the agent.
.. .. certificateCastringCA that issued the certificate.
.. .. divisionIdintegerDivision ID.
.. .. newCertOrderIdintegerOrder ID of the new certificate.
.. .. newCertCnstringCommon name of the new certificate.
.. .. profileIdintegerAutomation profile ID.
.. .. profileNamestringName of the profile.
.. .. sensorNamestringName of the sensor.
.. .. sensorLicenseKeystringLicense key associated with the sensor.
.. .. actionsarrayList of objects with action details.
.. .. .. actionTypestringType of the action performed. 0 -primary and 1 - secondary
.. .. .. actionarrayAction performed on the certificate. Possible values: renew, replace.
totalCountintegerTotal number of automated IPs.
totalPagesintegerTotal number of pages for the automated IPs.

Filter options for searchCriteriaList

The array includes key, operation, and value.

KeyOperationValue
COMMON_NAMEEQUALSCommon name.
LB_DATA_IPEQUALSData IP of the load balancer.
LB_DATA_PORTEQUALSData port of the load balancer.
CAEQUALSName of the CA.
AGENT_NAMEEQUALSName of the agent.
AUTOMATION_STATUSEQUALSACTION_REQUIRED, AUTOMATION_FAILED, SUCCESSFULLY_RENEWED, AUTO_RENEW_SCHEDULED, CERT_PENDING_APPROVAL, CONFIGURED, CSR_GENERATION_FAILED, INSTALL_FAILED, NOT_SCANNED, POST_CSR_FAILED
LB_APP_NAMEEQUALSApplication name of the load balancer.
LB_APP_VERSIONEQUALSApplication version of the load balancer.