List Specific Policy Object

Returns a specific policy object for the authenticated user.

SecuritybearerAuth
Request
path Parameters
id
required
integer

Policy ID for the specified policy

query Parameters
o
required
integer

Organization ID for the specified policy

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

get/policies/{id}
Request samples
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/policies/12345?o=0000"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content
Response samples
application/json
{
  • "id": 456321,
  • "uuid": "a9bee93b-5458-417f-87b9-bcda9e88afe",
  • "name": "Apply all Linux patches not requiring reboot",
  • "policy_type_name": "patch",
  • "organization_id": 634520,
  • "configuration": {
    • "filters": [
      • "*-firmware-*",
      • "*dbus-*",
      • "*systemd-*",
      • "*gnutls.*",
      • "*gnutls-*",
      • "*glibc.*",
      • "*glibc-*",
      • "*kernel-*",
      • "systemd",
      • "gnutls.x86_64",
      • "openssl-libs.x86_64",
      • "openssl-pkcs11.x86_64",
      • "udev",
      • "dbus"
      ],
    • "auto_patch": true,
    • "patch_rule": "filter",
    • "auto_reboot": false,
    • "filter_type": "exclude",
    • "device_filters": [
      • {
        • "op": "in",
        • "field": "os_family",
        • "value": [
          • "Linux"
          ]
        }
      ],
    • "notify_reboot_user": false,
    • "device_filters_enabled": true,
    • "notify_deferred_reboot_user": false,
    • "notify_user_message_timeout": 15,
    • "custom_notification_max_delays": 0,
    • "custom_notification_patch_message": "System Update: An important update will be installed.",
    • "notify_user_auto_deferral_enabled": true,
    • "custom_notification_reboot_message": "An important update will be installed; reboot may be required.",
    • "custom_notification_deferment_periods": [
      • 1,
      • 4,
      • 8
      ],
    • "custom_notification_patch_message_mac": "System Update: An important update will be installed.",
    • "custom_notification_reboot_message_mac": "An important update will be installed; reboot may be required.",
    • "custom_pending_reboot_notification_message": "Updates require reboot: Please save your work.",
    • "notify_deferred_reboot_user_message_timeout": 15,
    • "custom_pending_reboot_notification_max_delays": 6,
    • "custom_pending_reboot_notification_message_mac": "Updates require reboot: Please save your work.",
    • "notify_deferred_reboot_user_auto_deferral_enabled": true,
    • "custom_pending_reboot_notification_deferment_periods": [
      • 1,
      • 4,
      • 8
      ],
    • "secrets": { }
    },
  • "schedule_days": 254,
  • "schedule_weeks_of_month": 62,
  • "schedule_months": 8190,
  • "schedule_time": "03:00",
  • "use_scheduled_timezone": false,
  • "notes": "Schedule regular updates to software that don’t require a reboot",
  • "create_time": "2023-03-12T17:40:47+0000",
  • "server_groups": [
    • 102245,
    • 189887
    ],
  • "server_count": 2,
  • "status": "inactive",
  • "community_worklet_id": null,
  • "community_worklet_uuid": null,
  • "policy_template_id": 9
}