Sensor filter

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.

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

Name	Req/Opt	Type	Description
searchCriteriaList	optional	array	Filter results by specified values. For definitions, see the `Filter options for searchCriteriaList` table below. Example: `searchCriteriaList:[{"key":"state","operation":"EQUALS","value":["ACTIVE"]}]`
accountId	required		Account ID.
divisionIds	required	array	User's division IDs.
sortedColumnId	optional	string	Sort results by specified parameter. Allowed values: `serialNumber`, `ip`, `port`, `scanName`, `serverSecurity`, `isCertPresent`, `cn` Default: `isCertPresent`
sortOrder	optional	string	Sort direction. Allowed values: `DESC` (descending: 9-0, Z-A), `ASC` (ascending: 0-9, A-Z) Default: `DESC`
filterSelected	required	string	The value to show in the results for each sensor that meets the search criteria. Allowed values: `name`, `state`, `status`

Response parameters

Name	Type	Description
error	object	Includes error codes, if any.
data	object	Object with information about the filter results.
.. filterObjects	object	Object container for filter configuration details.
..filterName	string	Specified filter `key`.
..displayName	string	Friendly name of the filter key as it appears in the UI.
..values	array	List 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.

The array includes key, operation and value.

Key	Operation	Value
`name`	EQUALS	`Sensor name`
`state`	EQUALS	`Enable`, `Inactive`
`status`	EQUALS	`suspended`, `not_configured`, `install_pending`, `error`, `stopped`, `updating`, `update_pending`, `pending`, `scanning`, `configured`.

Request parameters

Response parameters

Filter options for searchCriteriaList

简介