Policy device filters preview

Generate a preview of the list of devices that matches the provided device filter set. For more information, see Policy and Device Filters, and Scheduling. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
query Parameters
o
required
integer

Organization ID. The organization will be assumed based on the API key, if not specified.

Example: o=123456
page
integer
Default: 0

The page of results you wish to be returned with page numbers starting at 0. See About Automox API - Pagination

limit
integer [ 1 .. 200 ]
Default: 25

A limit on the number of results to be returned, between 1 and 200 with a default of 25. Use with page parameter. See About Automox API - Pagination

Request Body schema: application/json
required
Array of objects
Array
field
string
Enum: "tag" "hostname" "ip_addr" "os_family" "os_version_id" "organizational_unit"
op
string
Enum Value Description
in

Field value in result. Corresponds to is on the console UI.

not_in

Field value not in result. Corresponds to is not on the console UI.

like_any

Field contains value. Corresponds to contains on the console UI.

not_like_any

Field does not contain value. Corresponds to does not contain on the console UI.

Array of strings or booleans or (Array of strings or integers) or numbers
Array
One of:
string
server_groups
Array of integers
Responses
200

Successful Operation

400

Invalid Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

429

Too many requests

503

Service Unavailable

default

Invalid Request

post/policies/device-filters-preview
Request samples
application/json
{
  • "device_filters": [
    • {
      • "field": "os_family",
      • "op": "in",
      • "value": [
        • "Windows"
        ]
      }
    ],
  • "server_groups": [
    • 901250,
    • 250624
    ]
}
Response samples
application/json
[
  • {
    • "results": [
      • {
        • "id": 0,
        • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        • "name": "string",
        • "custom_name": "string",
        • "os_version": "string",
        • "os_family": "string",
        • "server_group": {
          • "id": 0,
          • "organization_id": 0,
          • "name": "string",
          • "refresh_interval": 240,
          • "parent_server_group_id": 0
          },
        • "tags": [
          • "string"
          ],
        • "ip_addrs": [
          • "string"
          ],
        • "ip_addrs_private": [
          • "string"
          ],
        • "organizational_unit": [
          • "string"
          ]
        }
      ],
    • "size": 0
    }
]