Retrieves a policy device list.

This endpoint returns a paginated sortable list of devices including the last run result for each and reason for failure if applicable.

SecuritybearerAuth
Request
path Parameters
zoneUUID
required
string <uuid>

The UUID of the target zone.

policyUUID
required
string <uuid>

The ID of the target policy.

query Parameters
result:in[]
string

Filter for devices with the specified result

Enum: "success" "failed" "pending"
device.name:like
string

Filter for device names that contain the specified string

sort
string

Select one of the available sorting options

Enum Value Description
timestamp:asc

Sort by timestamp, in ascending order.

timestamp:desc

Sort by timestamp, in descending order.

result:asc

Sort by result, in ascending order.

result:desc

Sort by result, in descending order.

reason:asc

Sort by reason, in ascending order.

reason:desc

Sort by reason, in descending order.

device.name:asc

Sort by device name, in ascending order.

device.name:desc

Sort by device name, in ascending order.

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

get/zones/{zoneUUID}/reports/policies/{policyUUID}/devices
Request samples
Response samples
application/json
{
  • "metadata": {
    • "total_pages": 10,
    • "current_page": 0,
    • "limit": 500,
    • "total_count": 500,
    • "links": []
    },
  • "data": [
    • {
      • "timestamp": "2019-08-24T14:15:22Z",
      • "result": "success",
      • "reason": "device_updated",
      • "policy_id": 0,
      • "policy_uuid": "a6d56c42-9b85-44a2-b8d9-933cc15359f1",
      • "device_id": 0,
      • "device_uuid": "03910230-a84e-4578-8c2f-784cd16cdcc3",
      • "device_name": "string",
      • "zone_id": "4495020a-236f-46e0-9453-e3f9cc6476f4"
      }
    ]
}