Retrieves the Policy Results report.

Retrieves a paginated, sortable list of the latest result for each policy execution for a given zone.

SecuritybearerAuth
Request
path Parameters
zoneUUID
required
string <uuid>

The ID of the target zone.

query Parameters
name:like
string

Search for devices where the device name contains a given string.

name:in[]
string

Search for a given device name.

sort
string

Sort the report using the available options.

Enum: "name:asc" "name:desc" "statistics.failed:asc" "statistics.failed:desc" "statistics.success:asc" "statistics.success:desc" "statistics.pending:asc" "statistics.pending:desc" "total_results:asc" "total_results:desc" "total_success:asc" "total_success:desc"
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
Request samples
$apiKey = 'your_automox_api_key' $headers = @{
  "Authorization" = "Bearer $apiKey"
  "Content-Type" = "application/json"
  }
$url = "https://console.automox.com/api/zones/{zoneId}/reports/policies" $response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content
Response samples
application/json
{
  • "metadata": {
    • "total_pages": 10,
    • "current_page": 0,
    • "limit": 500,
    • "total_count": 500,
    • "links": []
    },
  • "data": [
    • {
      • "id": 0,
      • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      • "zone_id": "4495020a-236f-46e0-9453-e3f9cc6476f4",
      • "name": "string",
      • "type": "patch",
      • "statistics": {
        • "offline": 0,
        • "success": 0,
        • "missed": 0,
        • "failed": 0
        },
      • "total_results": 0,
      • "total_success": 0,
      • "execution_time": "2019-08-24T14:15:22Z"
      }
    ]
}