Search Device Details

Executes a dynamic search using the provided criteria and returns a page of matching devices

SecuritybearerAuth
Request
path Parameters
organizationUuid
required
string <uuid>

Organization UUID

Example: 8daf0e8d-1c0d-4f6f-b47b-21a59c10eab7
Request Body schema: application/json
required
Array of objects (SearchCriteria)
Deprecated

Deprecated flat criteria list

Array
scope
string
Default: "DEVICE"

Scope of the field

Enum: "DEVICE" "SOFTWARE" "TAGS" "IP_ADDRESS" "DISKS"
field
string

Field name

operator
string

Comparison operator

Enum: "EQ" "NOT_EQ" "GT" "LT" "GTE" "LTE" "MATCHES" "STARTS_WITH" "ENDS_WITH" "EMPTY" "IN"
values
Array of any

Values for the comparison

Array of objects (SortInstruction)

Sort instructions

Array
field
string

Field to sort by

ascending
boolean

Sort ascending if true

fields
Array of strings

Fields to include in the response

page
integer <int32>

Page number

size
integer <int32>

Page size

filters
Array of any (FilterCriterion)

Filter groups or criteria defining AND/OR logic

organizationUuids
Array of strings <uuid>

Organizations to scope the search

Responses
200

OK

4XX

Invalid Request

post/server-groups-api/v1/organizations/{organizationUuid}/device/search
Request samples
application/json
{
  • "criteria": [
    • {
      • "scope": "DEVICE",
      • "field": "string",
      • "operator": "EQ",
      • "values": [
        • null
        ]
      }
    ],
  • "sort": [
    • {
      • "field": "string",
      • "ascending": true
      }
    ],
  • "fields": [
    • "string"
    ],
  • "page": 0,
  • "size": 0,
  • "filters": [
    • null
    ],
  • "organizationUuids": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}
Response samples
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    • null
    ],
  • "number": 0,
  • "sort": {
    • "empty": true,
    • "sorted": true,
    • "unsorted": true
    },
  • "numberOfElements": 0,
  • "pageable": {
    • "offset": 0,
    • "sort": {
      • "empty": true,
      • "sorted": true,
      • "unsorted": true
      },
    • "paged": true,
    • "page_size": 0,
    • "page_number": 0,
    • "unpaged": true
    },
  • "empty": true
}