Agent filter
2 minute read
POST
Use this endpoint to get a list of automation agents based on the selected filter criteria.https://caas.digicert.com/automationws/v1/agent/filter
Example requests and responses
cURL
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
{
"error": null,
"data": {
"filterValues": [
"Agentless"
],
"totalCount": 1,
"totalPages": 1
}
}
Request parameters
| Name | Req/Opt | Type | Description |
|---|---|---|---|
| accountId | required | string | Account ID. |
| searchCriteriaList | optional | array | Filter results by specified values. For definitions, see the Filter options for searchCriteriaList table below. Example: |
| divisionIds | required | array | Division IDs. |
| startIndex | optional | integer | Index of the first result. Default: |
| 1 | |||
| pageSize | optional | integer | Number of records per page. Allowed values: 0 to 512 Default: 50 |
| filterSelected | required | string | The value to show in the results for each agent that meets the search criteria. Allowed values: AGENTYPE, AGENTNAME, SENSOR, HOSTNAME, AGENTSTATUS, DIVISION, LICENSEKEY. |
Response parameters
| Name | Type | Description |
|---|---|---|
| error | object | Object with error details, if any. |
| data | object | Object with response data. |
| .. filterValues | array | 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. |
| totalCount | integer | Total number of agents based on filter criteria. |
| totalPages | integer | Total number of pages for the agents based on filter criteria. |
Filter options for searchCriteriaList
The array includes key, operation, and value.
| Key | Operation | Value |
|---|---|---|
AGENTTYPE | EQUALS | Agent, Agentless |
AGENTNAME | EQUALS | Name of the agent. |
AGENTSTATUS | EQUALS | Error, Configured, Not Configured, Suspended, Upgrading, Void. |
LICENSEKEY | EQUALS | License key of the user. |
SENSOR | EQUALS | Name of the sensor. |
Was this page helpful?
Provide feedback