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

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

Use this endpoint to get a list of automation agents based on the selected filter criteria.

## Example requests and responses

## cURL

```bash
curl --location --request POST 'https://caas.digicert.com/automationws/v1/agent/filter' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": 5153184,
    "searchCriteriaList": [
        {
            "key": "AGENTSTATUS",
            "operation": "EQUALS",
            "value": [
                "Configured"
            ]
        }
    ],
    "divisionIds": [],
    "startIndex": 1,
    "pageSize": 50,
    "filterSelected": "AGENTTYPE"
}'
```

## 200 OK

```json
{
    "error": null,
    "data": {
        "filterValues": [
            "Agentless"
        ],
        "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. 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;AGENT_STATUS&quot;,
    &quot;operation&quot;:&quot;EQUALS&quot;,
    &quot;value&quot;:[&quot;Configured&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>filterSelected</td>
<td>required</td>
<td>string</td>
<td>The value to show in the results for each agent that meets the search criteria.<br>Allowed values: AGENTYPE, AGENTNAME, SENSOR, HOSTNAME, AGENTSTATUS, DIVISION, LICENSEKEY.</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>.. filterValues</td>
<td>array</td>
<td>List of agents that meet the search criteria. The value shown for each agent is the value set for the filterSelected parameter in the request body.</td>
</tr>
<tr>
<td>totalCount</td>
<td>integer</td>
<td>Total number of agents based on 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>