Search Devices in a Benchmark Set

POST {{cb_url}}/compliance/assessment/api/v1/orgs/{{cb_org_key}}/benchmark_sets/{{cb_benchmark_set_id}}/inventory/devices/_search

Get the Device Summary from Inventory for devices in a Benchmark Set.

RBAC Permissions Required

Permission (.notation name)	Operation(s)
complianceAssessment.data	READ

Request Schema

{
  "query": "<string>",
  "rows": "<integer>",
  "start": "<integer>",
  "criteria": {
      "<fieldname>": [
          "<string>"
      ]},
   "exclusions": {
      "<fieldname>": [
          "<string>"
      ]},
    "sort": [
        {
        "field": "<string>",
        "order": "<string>"
        }
    ]
}

See Documentation

Request Body

{"query"=>"windows", "rows"=>20, "start"=>0, "criteria"=>{"os_type"=>["WINDOWS"]}, "exclusions"=>{"cis_version"=>["1.4.0"]}, "sort"=>[{"field"=>"create_time", "order"=>"DESC"}]}

RESPONSES

status: OK

{&quot;num_found&quot;:4568,&quot;results&quot;:[{&quot;device_id&quot;:12345678,&quot;device_name&quot;:&quot;TEST\\DEMO-MACHINE&quot;,&quot;host_name&quot;:null,&quot;os_version&quot;:&quot;Windows Server 2019 x64&quot;,&quot;reason&quot;:&quot;ASSESSMENT_SCHEDULED&quot;,&quot;sensor_version&quot;:&quot;3.9.0&quot;,&quot;last_checkin_time&quot;:&quot;2023-12-19T08:37:03.126Z&quot;,&quot;deployment_type&quot;:&quot;WORKLOAD&quot;}]}