Sensor filter

  2 minute read  

POST https://daas.digicert.com/apicontroller/v1/sensor/filter
Use this endpoint to get a list of sensors filter based on the selected filter criteria.

Example requests and responses

cURL

curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/sensor/filter' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{"searchCriteriaList":[],"accountId":5153184,"divisionIds":[],"sortedColumnId":"name","sortOrder":"ASC","filterSelected":"status"}'

200 OK

{
    "error": null,
    "data": {
        "filterObjects": [
            {
                "filterName": "status",
                "displayName": "Status",
                "values": [
                    "error",
                    "install_pending",
                    "not_configured",
                    "stopped",
                    "suspended",
                    "update_pending"
                ]
            }
        ]
    }
}

Request parameters

NameReq/OptTypeDescription
searchCriteriaListoptionalarrayFilter results by specified values. For definitions, see the Filter options for searchCriteriaList table below.
Example:
accountIdrequiredAccount ID.
divisionIdsrequiredarrayUser’s division IDs.
sortedColumnIdoptionalstringSort results by specified parameter.
Allowed values: serialNumber, ip, port, scanName, serverSecurity, isCertPresent, cn
Default: isCertPresent
sortOrderoptionalstringSort direction.
Allowed values: DESC (descending: 9-0, Z-A), ASC (ascending: 0-9, A-Z)
Default: DESC
filterSelectedrequiredstringThe value to show in the results for each sensor that meets the search criteria.
Allowed values: name, state, status

Response parameters

NameTypeDescription
errorobjectIncludes error codes, if any.
dataobjectObject with information about the filter results.
.. filterObjectsobjectObject container for filter configuration details.
..filterNamestringSpecified filter key.
..displayNamestringFriendly name of the filter key as it appears in the UI.
..valuesarrayList of sensors that meet the search criteria. The value shown for each sensor is the value set for the filterSelected parameter in the request body.

Filter options for searchCriteriaList

The array includes key, operation and value.

KeyOperationValue
nameEQUALSSensor name
stateEQUALSEnable, Inactive
statusEQUALSsuspended, not_configured,install_pending, error,stopped, updating, update_pending, pending, scanning, configured.