---
title: "Get automation IPs list"
source_url: https://dev.digicert.com/certcentral-apis/automation-api/get-automation-ips-list.html
api_method: POST
api_endpoint: "/automationws/v1/automatedips/list"
api_url: "https://caas.digicert.com/automationws/v1/automatedips/list"
---

**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

```bash
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

```json
{
    "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

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>accountId</td>
<td>required</td>
<td>string</td>
<td>Account ID.</td>
</tr>
<tr>
<td>searchCriteriaList</td>
<td>optional</td>
<td>array</td>
<td>Filter results by specified values.<br>Example:<br><code>&quot;searchCriteriaList&quot;:[
  {
    &quot;key&quot;:&quot;AUTOMATION_STATUS&quot;,
    &quot;operation&quot;:&quot;EQUALS&quot;,
    &quot;value&quot;:[&quot;SUCCESSFULLY_RENEWED&quot;]
  }
]</code></td>
</tr>
<tr>
<td>.. key</td>
<td>optional</td>
<td>string</td>
<td>Field name (key) to search.<br>Allowed values: PROFILE_TYPE , LB_DATA_PORT, AUTOMATION_STATUS, LB_DATA_IP, CA, AGENT_NAME.</td>
</tr>
<tr>
<td>.. operation</td>
<td>optional</td>
<td>string</td>
<td>Filter operation.<br>Allowed values:EQUALS.</td>
</tr>
<tr>
<td>.. value</td>
<td>optional</td>
<td>array</td>
<td>List of values to filter against.</td>
</tr>
<tr>
<td>divisionIds</td>
<td>required</td>
<td>array</td>
<td>Division IDs.</td>
</tr>
<tr>
<td>pageSize</td>
<td>optional</td>
<td>integer</td>
<td>Number of records per page.<br>Allowed values:  0 to 512<br>Default: 50</td>
</tr>
<tr>
<td>startIndex</td>
<td>optional</td>
<td>integer</td>
<td>Index of the first result.<br>Default: 1.</td>
</tr>
<tr>
<td>sorting</td>
<td>optional</td>
<td>object</td>
<td>Sorting details.<br>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.<br>Allowed keys: commonName, automatedIp, automatedPort, ca, agentName, automationAgentAppName, automationStatus.<br>Allowed values: DESC (descending: 9-0, Z-A), ASC (ascending: 0-9, A-Z)<br>Examples:<br><ul><li>“sorting”: {“commonName”: “DESC”} Sorts results in descending order by common name.</li><li>“Sorting”: {commonName: “ASC”, “ca”: “DESC”} Sorts results in an ascending order by the common name first, then in a descending order by the certificate authority.</li></ul></td>
</tr>
<tr>
<td>filterSelected</td>
<td>optional</td>
<td>string</td>
<td>Name of the filter selected.</td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>error</td>
<td>object</td>
<td>Object with error details.</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>Object with response data.</td>
</tr>
<tr>
<td>.. automatedIps</td>
<td>array</td>
<td>List of objects with details about the results.</td>
</tr>
<tr>
<td>.. .. appInfo</td>
<td>object</td>
<td>Object with details about the application.</td>
</tr>
<tr>
<td>.. .. .. name</td>
<td>string</td>
<td>Name of the application.</td>
</tr>
<tr>
<td>.. .. .. version</td>
<td>string</td>
<td>Application version.</td>
</tr>
<tr>
<td>.. appPartition</td>
<td>string</td>
<td>The partition to which the data IP belongs.</td>
</tr>
<tr>
<td>.. .. automationId</td>
<td>integer</td>
<td>Automation ID.</td>
</tr>
<tr>
<td>.. .. automatedIp</td>
<td>string</td>
<td>IP that is automated.</td>
</tr>
<tr>
<td>.. .. automatedPort</td>
<td>integer</td>
<td>Port that is automated.</td>
</tr>
<tr>
<td>.. .. managementIp</td>
<td>string</td>
<td>Management IP. For more information, see Sensor automation on F5 load balancer.</td>
</tr>
<tr>
<td>.. .. agentName</td>
<td>string</td>
<td>Name of the agent.</td>
</tr>
<tr>
<td>.. .. automationStatus</td>
<td>string</td>
<td>Status of the automation. Possible values: ACTION_REQUIRED, SUCCESFULLY_RENEWED, AUTO_RENEW_SCHEDULED, AUTOMATION_FAILED, AUTOMATION_SCHEDULED, CONFIGURED,  INSTALL_VALIDATION_FAILED, INSTALL_FAILED, ERROR.</td>
</tr>
<tr>
<td>.. .. certificateCn</td>
<td>string</td>
<td>Common name of the certificate.</td>
</tr>
<tr>
<td>.. .. certificateExpiresOn</td>
<td>integer</td>
<td>Expiration date of the certificate. Format: epoch in milliseconds. Example: 1596781119</td>
</tr>
<tr>
<td>.. .. certificateId</td>
<td>string</td>
<td>ID of the CA certificate that signs the certificate.</td>
</tr>
<tr>
<td>.. .. certificateSerialNumber</td>
<td>string</td>
<td>Serial number of the certificate.</td>
</tr>
<tr>
<td>.. .. certProductType</td>
<td>string</td>
<td>Product ID for the certificate.</td>
</tr>
<tr>
<td>.. .. agentId</td>
<td>integer</td>
<td>ID of the agent.</td>
</tr>
<tr>
<td>.. .. certificateCa</td>
<td>string</td>
<td>CA that issued the certificate.</td>
</tr>
<tr>
<td>.. .. divisionId</td>
<td>integer</td>
<td>Division ID.</td>
</tr>
<tr>
<td>.. .. newCertOrderId</td>
<td>integer</td>
<td>Order ID of the new certificate.</td>
</tr>
<tr>
<td>.. .. newCertCn</td>
<td>string</td>
<td>Common name of the new certificate.</td>
</tr>
<tr>
<td>.. .. profileId</td>
<td>integer</td>
<td>Automation profile ID.</td>
</tr>
<tr>
<td>.. .. profileName</td>
<td>string</td>
<td>Name of the profile.</td>
</tr>
<tr>
<td>.. .. sensorName</td>
<td>string</td>
<td>Name of the sensor.</td>
</tr>
<tr>
<td>.. .. sensorLicenseKey</td>
<td>string</td>
<td>License key associated with the sensor.</td>
</tr>
<tr>
<td>.. .. actions</td>
<td>array</td>
<td>List of objects with action details.</td>
</tr>
<tr>
<td>.. .. .. actionType</td>
<td>string</td>
<td>Type of the action performed. <code>0</code> -primary and <code>1</code> - secondary</td>
</tr>
<tr>
<td>.. .. .. action</td>
<td>array</td>
<td>Action performed on the certificate. Possible values: renew, replace.</td>
</tr>
<tr>
<td>totalCount</td>
<td>integer</td>
<td>Total number of automated IPs.</td>
</tr>
<tr>
<td>totalPages</td>
<td>integer</td>
<td>Total number of pages for the automated IPs.</td>
</tr>
</tbody>
</table>

## Filter options for searchCriteriaList

The array includes key, operation, and value.

<table>
<thead>
<tr>
<th>Key</th>
<th>Operation</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>COMMON_NAME</code></td>
<td><code>EQUALS</code></td>
<td>Common name.</td>
</tr>
<tr>
<td><code>LB_DATA_IP</code></td>
<td><code>EQUALS</code></td>
<td>Data IP of the load balancer.</td>
</tr>
<tr>
<td><code>LB_DATA_PORT</code></td>
<td><code>EQUALS</code></td>
<td>Data port of the load balancer.</td>
</tr>
<tr>
<td><code>CA</code></td>
<td><code>EQUALS</code></td>
<td>Name of the CA.</td>
</tr>
<tr>
<td><code>AGENT_NAME</code></td>
<td><code>EQUALS</code></td>
<td>Name of the agent.</td>
</tr>
<tr>
<td><code>AUTOMATION_STATUS</code></td>
<td><code>EQUALS</code></td>
<td><code>ACTION_REQUIRED</code>, <code>AUTOMATION_FAILED</code>, <code>SUCCESSFULLY_RENEWED</code>, <code>AUTO_RENEW_SCHEDULED</code>, <code>CERT_PENDING_APPROVAL</code>, <code>CONFIGURED</code>, <code>CSR_GENERATION_FAILED</code>, <code>INSTALL_FAILED</code>, <code>NOT_SCANNED</code>, <code>POST_CSR_FAILED</code></td>
</tr>
<tr>
<td><code>LB_APP_NAME</code></td>
<td><code>EQUALS</code></td>
<td>Application name of the load balancer.</td>
</tr>
<tr>
<td><code>LB_APP_VERSION</code></td>
<td><code>EQUALS</code></td>
<td>Application version of the load balancer.</td>
</tr>
</tbody>
</table>