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

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

NameReq/OptTypeDescription
accountIdrequiredstringAccount ID.
searchCriteriaListoptionalarrayFilter results by specified values. For definitions, see the Filter options for searchCriteriaList table below.
Example:
divisionIdsrequiredarrayDivision IDs.
startIndexoptionalintegerIndex of the first result.
Default:
1
pageSizeoptionalintegerNumber of records per page.
Allowed values: 0 to 512
Default: 50
filterSelectedrequiredstringThe 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

NameTypeDescription
errorobjectObject with error details, if any.
dataobjectObject with response data.
.. filterValuesarrayList 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.
totalCountintegerTotal number of agents based on filter criteria.
totalPagesintegerTotal number of pages for the agents based on filter criteria.

Filter options for searchCriteriaList

The array includes key, operation, and value.

KeyOperationValue
AGENTTYPEEQUALSAgent, Agentless
AGENTNAMEEQUALSName of the agent.
AGENTSTATUSEQUALSError, Configured, Not Configured, Suspended, Upgrading, Void.
LICENSEKEYEQUALSLicense key of the user.
SENSOREQUALSName of the sensor.