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

**POST** `https://caas.digicert.com/automationws/v1/agent/list`

Use this endpoint to get a list of automation agents.

## Example requests and responses

## cURL

```bash
curl --location --request POST 'https://caas.digicert.com/automationws/v1/agent/list' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": 5153184,
    "searchCriteriaList": [],
    "divisionIds": [],
    "startIndex": 1,
    "pageSize": 50,
    "sorting": {
        "AGENTNAME": "ASC"
    }
}'
```

## 200 OK

```json
{
    "error": null,
    "data": {
        "agentList": [
            {
                "agentId": 1974,
                "accountId": "5153184",
                "divisionId": "677793",
                "hostname": "WIN-H4E1BFB5PE2",
                "agentName": "upgrade109-10110",
                "status": "Not Configured",
                "sensorName": "upgrade109-10110",
                "type": "Agent",
                "agentLicense": "4C78FD86EA557866",
                "updatePreference": 0,
                "updateAvailable": false
            },
            {
                "agentId": 2017,
                "accountId": "5153184",
                "divisionId": "677793",
                "hostname": "cws1-w16-m1-dap",
                "agentName": "SOWAgent-28sep",
                "status": "Not Configured",
                "sensorName": "SOWAgent-28sep",
                "type": "Agent",
                "agentLicense": "853029630D211D8D",
                "updatePreference": 1,
                "updateAvailable": false
            },
            {
                "agentId": 2012,
                "accountId": "5153184",
                "divisionId": "677793",
                "hostname": "gp2lab-f5.sbolab.blu.digicert.com",
                "agentName": "SOW-f5-10.100.192.227_7",
                "status": "Configured",
                "sensorLicenseKey": "C3FD89C967E92173",
                "sensorName": "SOWjanyaSensor",
                "type": "Agentless",
                "updateAvailable": false,
                "managementIp": "10.100.192.227"
            },
            {
                "agentId": 2018,
                "accountId": "5153184",
                "divisionId": "677793",
                "hostname": "gp2lab-thunder.sbolab.blu.digicert.com",
                "agentName": "SOW-A10-10.100.192.228",
                "status": "Configured",
                "sensorLicenseKey": "C3FD89C967E92173",
                "sensorName": "SOWjanyaSensor",
                "type": "Agentless",
                "updateAvailable": false,
                "managementIp": "10.100.192.228"
            },
            {
                "agentId": 1417,
                "accountId": "5153184",
                "divisionId": "677793",
                "hostname": "WIN-H4E1BFB5PE2",
                "agentName": "Proxyagent",
                "status": "Error",
                "sensorName": "Proxyagent",
                "type": "Agent",
                "agentLicense": "C9A67959E7CBD5E2",
                "updatePreference": 0,
                "updateAvailable": false
            },
            {
                "agentId": 1393,
                "accountId": "5153184",
                "divisionId": "677793",
                "hostname": "DC-C0FY5VD-L",
                "agentName": "856win10agent",
                "status": "Error",
                "sensorName": "856win10agent",
                "type": "Agent",
                "agentLicense": "9E38430DB99D75B3",
                "updatePreference": 1,
                "updateAvailable": false
            }
        ],
        "totalCount": 14,
        "totalPages": 2
    }
```

## 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. For definitions, see the <a href="#filter-options-for-searchcriterialist">Filter options for searchCriteriaList</a> table below.<br>Example:<br><code>&quot;searchCriteriaList&quot;:[
  {
    &quot;key&quot;:&quot;AGENTSTATUS&quot;,
    &quot;operation&quot;:&quot;EQUALS&quot;,
    &quot;value&quot;:[&quot;Error&quot;]
  }
]</code></td>
</tr>
<tr>
<td>divisionIds</td>
<td>required</td>
<td>array</td>
<td>Division IDs.</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>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>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 DESC order.<br>Allowed keys: AGENTNAME, AGENTSTATUS, HOSTNAME, AGENTYPE.<br>Allowed values:DESC (descending: 9-0, Z-A), ASC (ascending: 0-9, A-Z).<br>Examples:<br>“sorting”: {“AGENTNAME”: “ASC”}<br>Sorts results in ascending order by agent name.</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, if any.</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>Object with response data.</td>
</tr>
<tr>
<td>.. agentList</td>
<td>object</td>
<td>Object with details about the agents that meet the search criteria.</td>
</tr>
<tr>
<td>.. agentId</td>
<td>integer</td>
<td>Agent ID.</td>
</tr>
<tr>
<td>.. accountId</td>
<td>string</td>
<td>Account ID.</td>
</tr>
<tr>
<td>.. divisionId</td>
<td>string</td>
<td>Division ID.</td>
</tr>
<tr>
<td>.. hostname</td>
<td>string</td>
<td>Name of the host.</td>
</tr>
<tr>
<td>.. agentName</td>
<td>string</td>
<td>Name of the agent.</td>
</tr>
<tr>
<td>.. status</td>
<td>string</td>
<td>Status of the agent.<br>Possible values: Error, Configured, Not Configured, Suspended, Upgrading, Void .</td>
</tr>
<tr>
<td>.. sensorLicenseKey</td>
<td>string</td>
<td>License key associated with the sensor.<br>Note: Only returned if AGENTTYPE is selected as Agentless.</td>
</tr>
<tr>
<td>.. sensorName</td>
<td>string</td>
<td>Name of the sensor.</td>
</tr>
<tr>
<td>.. type</td>
<td>string</td>
<td>Type of the agent.<br>Possible values: Agent, Agentless.</td>
</tr>
<tr>
<td>.. agentLicense</td>
<td>string</td>
<td>License of the agent.</td>
</tr>
<tr>
<td>.. updatePreference</td>
<td>integer</td>
<td>Agent upgrade preference.<br><ul><li>0: Automatic upgrade.</li><li>1: Manual upgrade.Manually upgrade the agent from the CertCentral UI.</li></ul></td>
</tr>
<tr>
<td>.. updateAvailable</td>
<td>boolean</td>
<td>Indicates whether a new agent upgrade is available.<br>Possible values: false.</td>
</tr>
<tr>
<td>.. managementIp</td>
<td>string</td>
<td>Management IP. For more information, see Sensor automation on F5 load balancer.<br>Note: Only returned if AGENTTYPE is selected as Agentless.</td>
</tr>
<tr>
<td>totalCount</td>
<td>integer</td>
<td>Total number of agents based on the filter criteria.</td>
</tr>
<tr>
<td>totalPages</td>
<td>integer</td>
<td>Total number of pages for the agents based on filter criteria.</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>AGENTTYPE</code></td>
<td><code>EQUALS</code></td>
<td><code>Agent</code>, <code>Agentless</code>.</td>
</tr>
<tr>
<td><code>AGENTNAME</code></td>
<td><code>EQUALS</code></td>
<td>Name of the agent.</td>
</tr>
<tr>
<td><code>AGENTSTATUS</code></td>
<td><code>EQUALS</code></td>
<td><code>Error</code>, <code>Configured</code>, <code>Not Configured</code>, <code>Suspended</code>, <code>Upgrading</code>, <code>Void</code>.</td>
</tr>
<tr>
<td><code>LICENSEKEY</code></td>
<td><code>EQUALS</code></td>
<td>License key of the user.</td>
</tr>
<tr>
<td><code>SENSOR</code></td>
<td><code>EQUALS</code></td>
<td>Name of the sensor.</td>
</tr>
</tbody>
</table>