Addigy Tools
Written By Christopher Scaminaci
Last updated 7 days ago
Addigy Tools
addigy_ · 255 tools · Free 119 · Pro 136
Static x-api-key (v2 token, granular per-token permissions); fixed base https://api.addigy.com/api/v2; org-scoped paths take organizationId; page/per_page (cap 500).
All connector tools · Addigy setup guide
Addigy tool groups
- Devices — 16 tools
- Organization & Users — 14 tools
- Policies — 11 tools
- MDM Commands — 22 tools
- MDM Profiles & Settings — 23 tools
- Custom Facts — 10 tools
- End Users — 15 tools
- Monitoring & Alerts — 16 tools
- Software — 13 tools
- Prebuilt Apps — 9 tools
- Scripts & Maintenance — 17 tools
- System Updates — 13 tools
- Self Service — 4 tools
- Compliance & Benchmarks — 15 tools
- Integrations — 18 tools
- Variables & Static Fields — 16 tools
- Files, Exports & Reports — 9 tools
- Community — 7 tools
- Webhooks — 7 tools
Devices
addigy_assign_devices_to_policy details
addigy_assign_devices_to_policy details
[Addigy] Assign one or more devices to one or more policies. Required body fields: `agent_ids` (non-empty array of device agent IDs) and `policy_ids` (non-empty array of policy IDs). Requires organizationId (from addigy_list_child_organizations). Use addigy_get_device_policy_assignments to verify current assignments. Requires API token permission: Assign/Unassign Device Policies.
addigy_delete_device details
addigy_delete_device details
[Addigy] Remove a single device from Addigy by its serial number. DESTRUCTIVE — the device is deleted from the organization. NOTE: this endpoint is not intended for bulk removal. Requires organizationId (from addigy_list_child_organizations) and the device's serial number (sn). Requires API token permission: Delete Devices.
addigy_get_device_benchmark_compliance_status details
addigy_get_device_benchmark_compliance_status details
[Addigy] Get a device's compliance statuses per security benchmark for a specific organization. Returns an array of benchmark compliance statuses for the given agent. Requires organizationId (from addigy_list_child_organizations) and the device's agentId. Requires API token permission: View Devices.
addigy_get_device_policy_assignments details
addigy_get_device_policy_assignments details
[Addigy] Get the list of policy IDs assigned to a specific device. Returns an array of policy id strings. Requires organizationId (from addigy_list_child_organizations) and the device's agentId. Use addigy_assign_devices_to_policy / addigy_unassign_devices_from_policy to change assignments. Requires API token permission: View Devices.
addigy_get_managed_admin_password details
addigy_get_managed_admin_password details
[Addigy] Reveal the current managed admin password for a specific account on a device. NOTE: revealing the password also schedules a rotation on the device in one hour. Requires organizationId (from addigy_list_child_organizations), the device's agentId, and the accountName (discover via addigy_list_device_managed_admins). Requires API token permission: View Managed Admin Password.
addigy_get_mdm_device_details details
addigy_get_mdm_device_details details
[Addigy] Get MDM device details for a single device including enrollment profile, APN certificate, and last MDM response. The device UUID is the MDM device identifier (distinct from the agent_id used by /o/ device endpoints). Use addigy_search_devices to discover devices.
addigy_list_available_facts details
addigy_list_available_facts details
[Addigy] List the available device facts for an organization. Returns an array of fact definitions whose identifiers can be passed as desiredFactIdentifiers or used in filters for addigy_search_devices. Requires organizationId (from addigy_list_child_organizations).
addigy_list_device_managed_admins details
addigy_list_device_managed_admins details
[Addigy] List the managed admin accounts associated with a specific device. Returns managed-user records (account names and metadata). Requires organizationId (from addigy_list_child_organizations) and the device's agentId; optionally filter to a single accountName. Requires API token permission: View Mac Users.
addigy_query_devices_compliance_status details
addigy_query_devices_compliance_status details
[Addigy] Get overall compliance status for a set of devices. Provide agent_ids in fieldsJson to scope the query (omit/empty for all devices). Returns an array of device compliance statuses. Aggregates across child organizations when multitenancy=true. Requires API token permission: View Devices.
addigy_query_installed_apps_via_agent details
addigy_query_installed_apps_via_agent details
[Addigy] Query installed applications reported by the Addigy agent for one or more devices. macOS only. Build the filter via queryJson — required key `agent_ids` (array of agent IDs), optional `names` (array of application names, e.g. ["Google Chrome","Firefox"]). sortField and sortDirection are required by the API: sortField is one of agent_id|name; sortDirection is asc|desc. Paginated; response metadata carries page_count/total. Aggregates across child organizations when multitenancy=true. Requires API token permission: View Devices.
addigy_query_installed_apps_via_mdm details
addigy_query_installed_apps_via_mdm details
[Addigy] Query installed applications reported via MDM for one or more devices. Required body fields (all required by the API): `agent_ids` (array of agent IDs), `limit` (integer page size), `skip` (integer offset), `sort_field` (string, e.g. name), `sort_direction` (asc|desc). Uses skip/limit offset pagination rather than page numbers. Aggregates across child organizations when multitenancy=true. Requires API token permission: View Devices.
addigy_query_mdm_certificates details
addigy_query_mdm_certificates details
[Addigy] Paginated list of certificates installed on MDM devices. Build the filter via queryJson — supported keys: `days_until_expiration` (integer; certs expiring within N days), `issuer_common_name` (string), and `devices` (array of device identifiers). Useful for auditing expiring certificates across the fleet. Paginated; response metadata carries page_count/total. Requires API token permission: View Devices.
addigy_rotate_managed_admin_password details
addigy_rotate_managed_admin_password details
[Addigy] Rotate the managed admin password for a specific account on a device. Required body field: `accountName` (the managed admin account to rotate; discover via addigy_list_device_managed_admins). Requires organizationId (from addigy_list_child_organizations) and the device's agentId. Requires API token permission: Rotate Managed Admin Password.
addigy_search_devices details
addigy_search_devices details
[Addigy] Universal device search: query for devices by any device fact (e.g. serial_number, hostname, model). Returns a paginated audit response of matching devices. Build the search via queryJson — supported keys: `search_any` (free-text across facts), `policy_id`, and `filters` (array of audit filters); pass `desiredFactIdentifiers` (comma-separated fact ids from addigy_list_available_facts) to control which facts come back. Paginated; response metadata carries page_count/total. Org-scoping: omit organizationId to search the API key's own organization, or pass an organizationId (from addigy_list_child_organizations) to target a specific child organization. Requires API token permission: View Devices.
addigy_test_mdm_device_response details
addigy_test_mdm_device_response details
[Addigy] Test the MDM response for a single device — probes whether the device responds to an MDM command, useful for diagnosing unresponsive or stale MDM enrollments. The device UUID is the MDM device identifier; discover it via addigy_search_devices or addigy_get_mdm_device_details.
addigy_unassign_devices_from_policy details
addigy_unassign_devices_from_policy details
[Addigy] Unassign one or more devices from one or more policies. Required body fields: `agent_ids` (non-empty array of device agent IDs) and `policy_ids` (non-empty array of policy IDs). Requires organizationId (from addigy_list_child_organizations). Use addigy_get_device_policy_assignments to verify current assignments. Requires API token permission: Assign/Unassign Device Policies.
Organization & Users
addigy_create_user details
addigy_create_user details
[Addigy] Create a new organization user (admin). Required body fields: email (string), role (e.g. admin). Optional: name, phone, policies (array of policy id strings). Returns the created user record. To change an existing user use addigy_update_user; to list users use addigy_query_organization_users. Requires API token permission: Create User.
addigy_delete_user details
addigy_delete_user details
[Addigy] Remove a user from the organization, identified by their email. Discover existing users with addigy_query_organization_users. This is irreversible — re-add with addigy_create_user. Requires API token permission: Remove User.
addigy_disable_beta_feature details
addigy_disable_beta_feature details
[Addigy] Disable a Beta Feature for the organization, identified by its feature_flag_key (discover keys with addigy_list_public_beta_features). To re-enable use addigy_enable_beta_feature. Requires API token permission: Toggle Feature Betas.
addigy_enable_beta_feature details
addigy_enable_beta_feature details
[Addigy] Enable a Beta Feature for the organization. Required body field: feature_flag_key (string) — discover available keys with addigy_list_public_beta_features. To turn a feature back off use addigy_disable_beta_feature. Requires API token permission: Toggle Feature Betas.
addigy_get_api_key_permissions details
addigy_get_api_key_permissions details
[Addigy] Get the permission set granted to the API key currently in use. Returns an array of Addigy permission identifiers (e.g. com.addigy.devices.view, com.addigy.policies.edit — verified live 2026-08-26) describing exactly what this token can do; each identifier corresponds to a labeled permission on Addigy's API-token creation screen. Use this first to confirm a tool you intend to call is authorized.
addigy_get_billing_account details
addigy_get_billing_account details
[Addigy] Get the billing account record for a specific organization — contact, payment, and account-status details. Requires organizationId from addigy_list_child_organizations (or the org's own id). For usage/charge figures use addigy_get_billing_data; for invoices use addigy_list_billing_invoices. Requires API token permission: View Billing.
addigy_get_billing_data details
addigy_get_billing_data details
[Addigy] Get billing data (device counts, charges, and usage figures) for a specific organization. Requires organizationId from addigy_list_child_organizations (or the org's own id). For account contact details use addigy_get_billing_account; for invoices use addigy_list_billing_invoices. Requires API token permission: View Billing.
addigy_get_whoami details
addigy_get_whoami details
[Addigy] Identify the organization the API token belongs to, via GET /configuration/whoami. Returns {organization_id, name}. This is the ONLY self-discovery of the token's own organization id — the o// tools need that id, and on a single-organization account nothing else reveals it. NOTE: the endpoint is absent from Addigy's published Swagger spec; it was verified live 2026-08-26 and may change without notice.
addigy_list_billing_invoices details
addigy_list_billing_invoices details
[Addigy] List the billing invoices for a specific organization. Returns an array of invoice records (id, period, amount, status). Requires organizationId from addigy_list_child_organizations (or the org's own id). For the live account/usage figures use addigy_get_billing_account / addigy_get_billing_data. Requires API token permission: View Billing.
addigy_list_child_organizations details
addigy_list_child_organizations details
[Addigy] List the child organizations belonging to a parent organization (MSP multi-tenant view). Returns each child org's id, companyName, subdomain, and contact — the organizationId values needed by org-scoped tools (addigy_get_billing_account, addigy_query_organization_users, etc.). Supports searchString, sort, and a childOrganizationId filter to fetch one specific child. Paginated; response metadata has page/page_count/total.
addigy_list_public_beta_features details
addigy_list_public_beta_features details
[Addigy] List all Beta Features available to the organization, including each feature's flag key and whether it is currently enabled. Use the returned feature_flag_key with addigy_enable_beta_feature / addigy_disable_beta_feature to toggle a feature. Paginated; response metadata has page/page_count/total. Requires API token permission: Toggle Feature Betas.
addigy_query_ade_token_policy_assignments details
addigy_query_ade_token_policy_assignments details
[Addigy] Get the list of Automatic Device Enrollment (ADE / DEP) tokens assigned to the given policies. Required body field: policy_ids (array of strings). Returns the matching ADE token records (server name, expiration, assigned policy). Spans child organizations when multitenancy=true.
addigy_query_organization_users details
addigy_query_organization_users details
[Addigy] Query the users (admins) belonging to a specific organization. Returns a paginated list with each user's email, name, role, and policies. Requires organizationId from addigy_list_child_organizations (or the org's own id). Pass an optional queryJson body for additional filter fields supported by the endpoint. Paginated; response metadata has page/page_count/total. Requires API token permission: View Users.
addigy_update_user details
addigy_update_user details
[Addigy] Update an existing organization user, matched by email. Body fields: email (string, identifies the user to update), name, phone, role (e.g. admin). Discover existing users with addigy_query_organization_users. To create a new user use addigy_create_user; to remove one use addigy_delete_user. Requires API token permission: Edit User.
Policies
addigy_create_policy details
addigy_create_policy details
[Addigy] Create a new policy within a specific organization. Required body field: `name`. Optional body fields: `color`, `icon` (fa fa-user|fa fa-users|fa fa-trophy|fa fa-university|fa fa-database|fa fa-desktop|fa fa-building-o|fa fa-lock|fa fa-dog|fa fa-mobile|fa fa-wrench|fa fa-user-graduate|fa fa-cog|fa fa-laptop|fa fa-box-open|fa fa-globe-americas), `parent_policy_id` (nest under an existing policy — discover via addigy_query_policies), `splashtop_settings` and `ssh_settings` (each an object with `enabled` and `require_user_permission` booleans). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Create Policy.
addigy_create_policy_rule details
addigy_create_policy_rule details
[Addigy] Add an automatic-assignment (Smart Software / custom filter) rule to a policy within an organization. Devices matching the rule's filters are auto-assigned to the policy. Body fields: `policy_id` (target policy — discover via addigy_query_policies), `filters` (array of filter groups; each group is an array of correlation_engine.Filter conditions), `auto_remove` (bool — unassign devices that stop matching), `disabled` (bool). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Automatic Policy Assignments.
addigy_delete_policy details
addigy_delete_policy details
[Addigy] Permanently delete a policy from a specific organization. Identify the policy with the `id` query parameter (the policy's ID — discover via addigy_query_policies). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Delete Policy.
addigy_delete_policy_parent details
addigy_delete_policy_parent details
[Addigy] Detach a policy from its parent, promoting it to a top-level policy within an organization. Identify the policy with the `policy_id` query parameter (discover via addigy_query_policies). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Edit Policy.
addigy_delete_policy_rule details
addigy_delete_policy_rule details
[Addigy] Remove an automatic-assignment rule from a policy within an organization. Identify the rule with both the `policy_id` and `rule_id` query parameters — discover them via addigy_get_policy_rule or addigy_list_policy_rules. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Automatic Policy Assignments.
addigy_get_policy_rule details
addigy_get_policy_rule details
[Addigy] Get the automatic-assignment rule configured for a single policy within an organization. Identify the policy with the `policy_id` query parameter (discover via addigy_query_policies). Use addigy_list_policy_rules to enumerate rules across all policies. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Automatic Policy Assignments.
addigy_list_mdm_profile_policy_assignments details
addigy_list_mdm_profile_policy_assignments details
[Addigy] List the MDM configuration profiles currently assigned to policies for the API key's own organization. Returns each policy together with the MDM profiles attached to it. Use addigy_query_policies to discover policy IDs and names. Paginated via page/per_page (default 50, max 500); the response metadata envelope carries page/page_count/per_page/result_count/total.
addigy_list_policy_rules details
addigy_list_policy_rules details
[Addigy] List all automatic-assignment (custom filter) rules across every policy in an organization. Returns each rule with its associated policy and filter conditions. Use addigy_get_policy_rule for a single policy's rule. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Automatic Policy Assignments.
addigy_query_policies details
addigy_query_policies details
[Addigy] Query an organization for all policies, or filter to specific policies, and return their full info. This is the primary discovery tool for policy IDs and names referenced by the other Policies tools. Optional body field: `policies` (array of policy ID strings to filter to; omit or pass an empty body to return all policies). Aggregates across child organizations when multitenancy=true; scope to specific children via childOrganizations.
addigy_update_policy details
addigy_update_policy details
[Addigy] Update an existing policy's editable attributes (name, color, icon) for a specific organization. Required body field: `policy_id` (the target policy's ID — discover via addigy_query_policies). Optional body fields: `name`, `color`, `icon` (one of: fa fa-user, fa fa-users, fa fa-trophy, fa fa-university, fa fa-database, fa fa-desktop, fa fa-building-o, fa fa-lock, fa fa-dog, fa fa-mobile, fa fa-wrench, fa fa-user-graduate, fa fa-cog, fa fa-laptop, fa fa-box-open, fa fa-globe-americas). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Edit Policy.
addigy_update_policy_parent details
addigy_update_policy_parent details
[Addigy] Re-parent a policy, moving it under a different parent policy within an organization (changes the policy hierarchy). Required body fields: `policy_id` (the policy being moved) and `parent_policy_id` (its new parent). Discover both IDs via addigy_query_policies. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Edit Policy.
MDM Commands
addigy_clear_passcode details
addigy_clear_passcode details
[Addigy] Issue an MDM Clear Passcode command, removing the unlock passcode from a managed device. Identify the target by EITHER agentId OR deviceUuid (provide exactly one — agentId comes from addigy_list_devices, deviceUuid from addigy_get_mdm_device_details). Requires API token permission: Execute Commands. Returns the queued MDM command payload (command UUID + status).
addigy_clear_restrictions_password details
addigy_clear_restrictions_password details
[Addigy] Issue an MDM Clear Restrictions Password command, removing the restrictions (Screen Time) passcode from a managed device. Identify the device by EITHER agentId OR deviceUuid (provide exactly one). Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_delete_device_user details
addigy_delete_device_user details
[Addigy] Issue an MDM Delete User command, removing an active local user account from a managed device. Identify the device by EITHER agentId OR deviceUuid (provide exactly one). Required: username (the account to delete) and forceDeletion. Discover known device users with addigy_list_mdm_device_users. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_disable_lost_mode details
addigy_disable_lost_mode details
[Addigy] Issue an MDM command that disables Lost Mode on a managed device (re-enable with addigy_enable_lost_mode). Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_disable_remote_desktop details
addigy_disable_remote_desktop details
[Addigy] Issue an MDM command that disables Remote Desktop (screen sharing) on a managed device (re-enable with addigy_enable_remote_desktop). Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_enable_lost_mode details
addigy_enable_lost_mode details
[Addigy] Issue an MDM command that puts a managed device into Lost Mode with an on-screen message, phone number, and footnote. A message OR phone number must be provided. Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Body properties: message (string), phone_number (string), footnote (string), agent_id. Disable later with addigy_disable_lost_mode; locate with addigy_get_device_location. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_enable_remote_desktop details
addigy_enable_remote_desktop details
[Addigy] Issue an MDM command that enables Remote Desktop (screen sharing) on a managed device (disable with addigy_disable_remote_desktop). Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_erase_device details
addigy_erase_device details
[Addigy] Issue an MDM Erase Device command, wiping a managed macOS/iOS/iPadOS/tvOS device. Provide a JSON body with required `device_uuid` (all OSes). macOS: `pin` (six-character Find My PIN, required for devices without Apple M1/T2 EACS support) and `obliteration_behavior` (DoNotObliterate|ObliterateWithWarning|Always|Default). iOS/iPadOS: `disallow_proximity_setup` (bool, default false) and `preserve_data_plan` (bool, default false). Requires API token permission: Execute Commands. This command does not require supervision. Returns the queued MDM command payload.
addigy_get_command_output details
addigy_get_command_output details
[Addigy] Retrieve the captured output (stdout/stderr/exit status) of a previously dispatched device command. Requires organizationId (discover with addigy_list_child_organizations), agentId (from addigy_list_devices), and actionId (the command/action identifier returned by addigy_run_device_command). Returns the CommandOutput record.
addigy_get_device_location details
addigy_get_device_location details
[Addigy] Issue an MDM command asking a device in Lost Mode to report its current location (enable Lost Mode first with addigy_enable_lost_mode; read the last reported coordinates with addigy_get_last_device_location). Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_get_last_device_location details
addigy_get_last_device_location details
[Addigy] Read the last known location reported by a device while in Lost Mode (request a fresh report with addigy_get_device_location). Identify the device by EITHER agentId OR deviceUuid (provide exactly one). Requires API token permission: Execute Commands. Returns the cached LostMode location record.
addigy_list_device_users details
addigy_list_device_users details
[Addigy] Issue an MDM Request User List command, asking a managed device to report its local user accounts to Addigy (read the cached result afterward with addigy_list_mdm_device_users). Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_list_mdm_device_users details
addigy_list_mdm_device_users details
[Addigy] Return the list of known device users previously reported to Addigy via the Request User List command (addigy_list_device_users triggers that command). Identify the device by EITHER agentId OR deviceUuid (provide exactly one). Requires API token permission: Execute Commands. Returns an array of MdmDeviceUser records.
addigy_lock_device details
addigy_lock_device details
[Addigy] Issue an MDM Device Lock command, rendering the device unusable until the passcode is entered. Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Optional body properties: message and phone_number (shown on the lock screen) and pin (six-digit recovery PIN for macOS). Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_play_lost_mode_sound details
addigy_play_lost_mode_sound details
[Addigy] Issue an MDM command that plays a sound on a device currently in Lost Mode (enable Lost Mode first with addigy_enable_lost_mode). Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_request_airplay_mirroring details
addigy_request_airplay_mirroring details
[Addigy] Issue an MDM command prompting the user to share their screen via AirPlay Mirroring to a destination device. Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Body properties: destination_device_id (e.g. "AA:BB:CC:DD:EE:FF"), destination_name (e.g. "My Apple TV"), scan_time (integer 10–300, e.g. 30), password (optional), agent_id. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_restart_device details
addigy_restart_device details
[Addigy] Issue an MDM command that immediately restarts a managed device. Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_rotate_filevault_key details
addigy_rotate_filevault_key details
[Addigy] Issue an MDM command that rotates the FileVault personal recovery key on a managed macOS device. Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_run_device_command details
addigy_run_device_command details
[Addigy] Run an arbitrary shell command on one or more devices within an organization. Requires organizationId (discover with addigy_list_child_organizations). Provide a JSON body with required `agent_ids` (non-empty array of agent IDs from addigy_list_devices) and `command` (the shell command text). Optional: `background` (bool), `run_as_client` (bool). Retrieve results afterward with addigy_get_command_output using the returned action id. Returns an array of Command records.
addigy_shutdown_device details
addigy_shutdown_device details
[Addigy] Issue an MDM command that shuts down a managed device. Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_stop_airplay_mirroring details
addigy_stop_airplay_mirroring details
[Addigy] Issue an MDM command that stops AirPlay screen mirroring on a managed device. Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
addigy_unlock_device_user details
addigy_unlock_device_user details
[Addigy] Issue an MDM command that unlocks a locked-out local user account on a managed device. Provide a JSON body identifying the device by EXACTLY ONE of `agent_id` or `device_uuid`, plus `username` (the account to unlock). Discover known device users with addigy_list_mdm_device_users. Requires API token permission: Execute Commands. Returns the queued MDM command payload.
MDM Profiles & Settings
addigy_assign_mdm_profile_to_policies details
addigy_assign_mdm_profile_to_policies details
[Addigy] Assign an MDM configuration profile to one or more policies. Body fields: `groupId` (the profile's payload group ID, discover via addigy_list_mdm_configuration_profiles), `policyIds` (array of policy IDs to attach), and `channel` (delivery channel). Use addigy_unassign_mdm_profile_from_policies to reverse.
addigy_create_custom_mdm_profile details
addigy_create_custom_mdm_profile details
[Addigy] Create a Custom MDM Profile by uploading a raw .mobileconfig file. Provide the .mobileconfig XML as `profileContent` and an upload `fileName`. Optionally set minimum OS versions to scope which platforms receive it (leave a version empty/null to NOT target that platform). For Addigy-native (non-custom) payloads use addigy_create_mdm_profile instead. Requires API token permission: Create MDM Profiles.
addigy_create_mdm_profile details
addigy_create_mdm_profile details
[Addigy] Create an Addigy-native MDM profile (not a raw .mobileconfig — use addigy_create_custom_mdm_profile for that). Body fields include payload metadata plus a `payloads` array of MDM payload objects. Per-payload required keys: payload_display_name (1–160 chars), payload_type (Apple type string such as com.apple.airplay, must not be empty), payload_priority (integer, default 9). Profiles with multiple payloads are not supported. NOTE: payload key names use snake_case (e.g. allow_passcode_modification), not Apple camelCase. Use addigy_list_mdm_profile_definitions / addigy_get_mdm_profile_definition to learn each payload's required keys. Requires API token permission: Create MDM Profiles.
addigy_delete_mdm_profile details
addigy_delete_mdm_profile details
[Addigy] Permanently delete an MDM configuration profile by its payload group ID. The `payloadGroupId` identifies the profile to remove — discover it via addigy_list_mdm_configuration_profiles or addigy_get_mdm_profile. This removes the profile and is not reversible.
addigy_deploy_profile_to_devices details
addigy_deploy_profile_to_devices details
[Addigy] Deploy an MDM profile directly to a list of devices and/or managed users. This is an ATOMIC request — if any single target errors, NO profile is deployed to ANY target. Body fields: `payloads_group_id` (profile payload group ID, discover via addigy_list_mdm_configuration_profiles), `devices_uuid` (array of device UUIDs), and `devices_user_ids` (object mapping device to managed-user ID arrays). Requires API token permissions: View Devices, Execute commands.
addigy_get_mdm_profile details
addigy_get_mdm_profile details
[Addigy] Get a single MDM configuration profile by its payload group ID, including its configuration payloads. The `payloadGroupId` identifies the profile — discover it via addigy_list_mdm_configuration_profiles. Use addigy_update_mdm_profile_payloads to modify it or addigy_delete_mdm_profile to remove it.
addigy_get_mdm_profile_definition details
addigy_get_mdm_profile_definition details
[Addigy] Get the MDM configuration profile DEFINITION (payload manifest / schema) for a single Addigy payload type. Returns the field/key manifest describing what keys a payload of this type accepts — useful before building a body for addigy_create_mdm_profile. The `addigyPayloadType` is Addigy's payload-type identifier; use addigy_list_mdm_profile_definitions to discover all available payload types.
addigy_install_mdm_enrollment_profile details
addigy_install_mdm_enrollment_profile details
[Addigy] Install an MDM enrollment profile on a device (via MDM if available, otherwise via the Addigy agent for macOS devices). Requires `organizationId` (the target organization — discover via addigy_list_child_organizations). Body field: `udid` (the device UDID to enroll).
addigy_list_mdm_configuration_profiles details
addigy_list_mdm_configuration_profiles details
[Addigy] List all MDM configuration profiles in the organization, with their configuration payloads. Use this to discover payload group IDs for addigy_get_mdm_profile, addigy_update_mdm_profile_payloads, addigy_delete_mdm_profile, and addigy_assign_mdm_profile_to_policies. For the lighter MDM-profile listing (vendor/Apple-pushed profiles) use addigy_list_mdm_profiles.
addigy_list_mdm_profile_definitions details
addigy_list_mdm_profile_definitions details
[Addigy] List all MDM configuration profile DEFINITIONS (payload manifests / schemas). Returns the array of every Addigy-supported payload type and its key manifest. Use this to discover valid `addigyPayloadType` values for addigy_get_mdm_profile_definition and to learn the fields required when building a body for addigy_create_mdm_profile.
addigy_list_mdm_profiles details
addigy_list_mdm_profiles details
[Addigy] Get a list of MDM profiles (the profiles installed on / pushed via MDM). For the richer configuration-profile listing with full payloads, use addigy_list_mdm_configuration_profiles instead.
addigy_list_policy_profiles_by_payload_type details
addigy_list_policy_profiles_by_payload_type details
[Addigy] List the MDM profiles configured on a specific policy that match a given payload type. Requires both a `policyId` and a `payloadType`. Use this to inspect which profiles of a particular type (e.g. com.apple.airplay) a policy already carries before editing. Discover payload types via addigy_list_mdm_profile_definitions.
addigy_query_mdm_payloads details
addigy_query_mdm_payloads details
[Addigy] Query MDM payload information and policy assignments for a specific organization. Requires `organizationId` (discover via addigy_list_child_organizations). Optional body fields: `payload_group_ids` (array — restrict to these payload group IDs) and `excluded_payload_group_ids` (array — exclude these). Omit the body to query all. Use addigy_list_mdm_configuration_profiles to discover payload group IDs.
addigy_set_app_analytics details
addigy_set_app_analytics details
[Addigy] Send an MDM command to enable/disable app analytics sharing with app developers. Available in Shared iPad mode on iOS 9.3.2+. Body fields: `app_analytics` (boolean — true enables, false disables) and exactly one device target: `device_uuid` or `agent_id`. Requires API token permission: Execute Commands.
addigy_set_bluetooth_state details
addigy_set_bluetooth_state details
[Addigy] Send an MDM command to enable/disable Bluetooth. Available in iOS 11.3+ on supervised devices and macOS 10.13.4+. Body fields: `bluetooth` (boolean — true enables, false disables) and exactly one device target: `device_uuid` or `agent_id`. Requires API token permission: Execute Commands.
addigy_set_data_roaming details
addigy_set_data_roaming details
[Addigy] Send an MDM command to enable/disable data roaming. Enabling data roaming also enables voice roaming. Body fields: `data_roaming` (boolean — true enables, false disables) and exactly one device target: `device_uuid` or `agent_id`. Requires API token permission: Execute Commands.
addigy_set_device_name details
addigy_set_device_name details
[Addigy] Send an MDM command to set a device's name. Available only on supervised devices or macOS 10.10+. On macOS this sets the computer name and local hostname. Body fields: `device_name` (string), `host_name` (string, macOS) and exactly one device target: `device_uuid` or `agent_id`. Requires API token permission: Execute Commands.
addigy_set_diagnostic_submission details
addigy_set_diagnostic_submission details
[Addigy] Send an MDM command to set the user preference for diagnostic submission. Shared iPad mode only; available in iOS 9.3+. Body fields: `diagnostic_submission` (boolean — true enables, false disables) and exactly one device target: `device_uuid` or `agent_id`. Requires API token permission: Execute Commands.
addigy_set_personal_hotspot details
addigy_set_personal_hotspot details
[Addigy] Send an MDM command to enable/disable Personal Hotspot. Only available on certain carriers. Body fields: `personal-hotspot` (boolean — true enables, false disables) and exactly one device target: `device_uuid` or `agent_id`. Requires API token permission: Execute Commands.
addigy_set_voice_roaming details
addigy_set_voice_roaming details
[Addigy] Send an MDM command to enable/disable voice roaming. Only available on certain carriers. Disabling voice roaming also disables data roaming. Body fields: `voice-roaming` (boolean — true enables, false disables) and exactly one device target: `device_uuid` or `agent_id`. Requires API token permission: Execute Commands.
addigy_set_wallpaper details
addigy_set_wallpaper details
[Addigy] Send an MDM command to set a device's wallpaper (a one-time setting the user can later change). Supervised mode only; iOS 8+. Body fields: `image` (Base64-encoded PNG or JPEG), `where` (integer: 1=Lock screen, 2=Home/icon-list screen, 3=Lock and Home screens) and exactly one device target: `device_uuid` or `agent_id`. Requires API token permission: Execute Commands.
addigy_unassign_mdm_profile_from_policies details
addigy_unassign_mdm_profile_from_policies details
[Addigy] Unassign (detach) an MDM configuration profile from one or more policies. Body fields: `groupId` (the profile's payload group ID), `policyIds` (array of policy IDs to detach), and `channel` (delivery channel). This is the reverse of addigy_assign_mdm_profile_to_policies; it removes the profile from those policies.
addigy_update_mdm_profile_payloads details
addigy_update_mdm_profile_payloads details
[Addigy] Update (REPLACE) an MDM profile's payloads. IMPORTANT: this is a full REPLACE — partial data is not supported; the existing payload is removed and recreated from exactly what you send, so provide the COMPLETE payload structure. Some keys must match the existing payload to identify what to replace (payload_identifier, payload_group_id, payload_uuid). Per-payload required keys: payload_display_name, payload_type, payload_priority, plus the type's required snake_case keys. For Custom Profiles, modify and base64-encode the `custom_profile_content` field. Discover the profile via addigy_get_mdm_profile. Requires API token permission: Edit MDM Profiles.
Custom Facts
addigy_assign_custom_fact_to_policy details
addigy_assign_custom_fact_to_policy details
[Addigy] Assign a custom fact to one or more policies. Body fields: `id` (the custom fact id, from addigy_list_custom_facts) and `policies` (array of policy ids). Acts on the API key's own organization by default; pass organizationId (from addigy_list_child_organizations) to act on a specific child organization. Use addigy_unassign_custom_fact_from_policy to remove an assignment.
addigy_create_custom_fact details
addigy_create_custom_fact details
[Addigy] Create a custom fact. Body fields: `name`, `return_type`, `notes`, and `os_architectures` (object with `linux` and `macOS` architecture settings). Returns the new fact (including its id). Acts on the API key's own organization by default; pass organizationId (from addigy_list_child_organizations) to create the fact in a specific child organization.
addigy_delete_custom_fact details
addigy_delete_custom_fact details
[Addigy] Delete a custom fact by its id. Discover ids with addigy_list_custom_facts or addigy_query_custom_facts. Acts on the API key's own organization by default; pass organizationId (from addigy_list_child_organizations) to delete the fact in a specific child organization instead. This permanently removes the fact definition.
addigy_get_custom_fact details
addigy_get_custom_fact details
[Addigy] Get a single custom fact by id within a specific organization. Returns the fact's id, name, return_type, notes, and os_architectures. Requires organizationId (from addigy_list_child_organizations) and the custom fact id (from addigy_list_custom_facts or addigy_query_custom_facts). Use addigy_get_custom_fact_usage to see where the fact is referenced.
addigy_get_custom_fact_usage details
addigy_get_custom_fact_usage details
[Addigy] Get the usage of a custom fact within a specific organization — where the fact is referenced (e.g. by policies). Requires organizationId (from addigy_list_child_organizations) and the custom fact id (from addigy_list_custom_facts or addigy_query_custom_facts). Use addigy_get_custom_fact for the fact's own definition.
addigy_list_custom_facts details
addigy_list_custom_facts details
[Addigy] Get all custom facts defined for the API key's own organization. Returns each custom fact's id, name, return_type, notes, and os_architectures. Use addigy_get_custom_fact (with organizationId from addigy_list_child_organizations) for one fact's full detail, or addigy_query_custom_facts to filter by id/name. Paginated; response metadata carries page/page_count/per_page/result_count/total.
addigy_query_custom_facts details
addigy_query_custom_facts details
[Addigy] Get a paginated list of custom facts for the organization, filtered by id or name. Optional filter (via filtersJson) supports `id` (exact match) and `name_contains` (substring). Supports sort_field (e.g. name) and sort_direction (asc/desc). Returns the same fact shape as addigy_list_custom_facts. Paginated; response metadata carries page/page_count/per_page/result_count/total.
addigy_query_custom_facts_aggregate details
addigy_query_custom_facts_aggregate details
[Addigy] Get a paginated list of custom facts aggregated across organizations. Optional filter (via filtersJson) supports `name_contains` (substring) and `ids` (array of fact ids). Supports sort_field (e.g. name) and sort_direction (asc/desc). per_page is capped at 100 by the API. Spans child organizations when multitenancy=true; scope with childOrganizations. Requires API token permission: View custom facts. Paginated; response metadata carries page/page_count/per_page/result_count/total.
addigy_unassign_custom_fact_from_policy details
addigy_unassign_custom_fact_from_policy details
[Addigy] Unassign a custom fact from a policy. Requires the custom fact `id` (from addigy_list_custom_facts) and the `policy_id`. Acts on the API key's own organization by default; pass organizationId (from addigy_list_child_organizations) to act on a specific child organization. Use addigy_assign_custom_fact_to_policy to reassign.
addigy_update_custom_fact details
addigy_update_custom_fact details
[Addigy] Update an existing custom fact. Body fields: `id` (required — the fact to update, from addigy_list_custom_facts), `name`, `return_type`, `notes`, and `os_architectures` (object with `linux` and `macOS` architecture settings). Acts on the API key's own organization by default; pass organizationId (from addigy_list_child_organizations) to update the fact in a specific child organization.
End Users
addigy_assign_device_to_end_user details
addigy_assign_device_to_end_user details
[Addigy] Assign a device (agent) to an end user. Required body fields: `end_user_id` (from addigy_query_end_users), `agent_id` (the device's agent id). Use addigy_query_end_user_devices to view existing assignments. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Manage end users.
addigy_delete_end_user_device_assignments details
addigy_delete_end_user_device_assignments details
[Addigy] Remove device assignments from an end user. Required body field: `end_user_id` (from addigy_query_end_users). Optional `agent_ids` (array of device agent ids) — omit to remove all of the end user's device assignments, or supply specific ids to remove only those. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Manage end users.
addigy_delete_end_user_scim_credentials details
addigy_delete_end_user_scim_credentials details
[Addigy] Delete one or more SCIM credentials by external id. Required body field: `external_ids` (array of external id strings, at least one — discover via addigy_query_end_user_scim_credentials). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Manage end users.
addigy_disable_end_user_scim details
addigy_disable_end_user_scim details
[Addigy] Disable the SCIM integration that provisions end users for this organization. Stops SCIM-driven end-user sync. Re-enable with addigy_enable_end_user_scim. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Manage end users.
addigy_enable_end_user_scim details
addigy_enable_end_user_scim details
[Addigy] Enable a SCIM integration to provision end users for this organization. Returns the new SCIM credentials (token/external id) needed by your identity provider. Required body field: `name` (display name, min length 1). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Manage end users.
addigy_get_end_user details
addigy_get_end_user details
[Addigy] Get a single end user by id. Returns the end_user record (id, display name, email, active state, tenant/group associations). Requires organizationId (from addigy_list_child_organizations) and endUserId (discover ids via addigy_query_end_users). Requires API token permission: View end users.
addigy_get_end_user_scim_credentials details
addigy_get_end_user_scim_credentials details
[Addigy] Get the SCIM credentials for one SCIM integration by external id. Returns the integration's credential record. Requires externalId (discover via addigy_query_end_user_scim_credentials). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Manage end users.
addigy_import_end_user_devices details
addigy_import_end_user_devices details
[Addigy] Bulk-import end users and their device assignments from an inventory file (multipart upload). Provide the file contents as text and a file name. Returns import metadata (file id, status) — poll progress with addigy_query_end_user_device_import_metadata. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Manage end users.
addigy_query_end_user_device_import_metadata details
addigy_query_end_user_device_import_metadata details
[Addigy] Query metadata for prior end-user device imports (status, counts, errors per import file). Use this to monitor an import started by addigy_import_end_user_devices. Optional filter: file_ids (array of import file ids). Paginated; response metadata has page/page_count/total. Requires organizationId from addigy_list_child_organizations. Requires API token permission: View end users.
addigy_query_end_user_devices details
addigy_query_end_user_devices details
[Addigy] Query device assignments for end users. Returns end-user-to-device links. Optional filter: end_user_ids and/or agent_ids (arrays of ids). Use addigy_assign_device_to_end_user / addigy_delete_end_user_device_assignments to change assignments. Paginated; response metadata has page/page_count/total. Requires organizationId from addigy_list_child_organizations. Requires API token permission: View end users.
addigy_query_end_user_groups details
addigy_query_end_user_groups details
[Addigy] Query end-user groups. Returns groups with id, display name, and membership metadata. Optional filters: search (free-text), tenant_ids (array), ids (array of group ids). Use the returned group ids with addigy_query_end_users (group_ids filter) to list members. Paginated; response metadata has page/page_count/total. Requires organizationId from addigy_list_child_organizations. Requires API token permission: View end users.
addigy_query_end_user_scim_credentials details
addigy_query_end_user_scim_credentials details
[Addigy] Query SCIM credentials configured for end-user provisioning. Returns credential records with external ids and display names. Optional filters: search (free-text), external_ids (array). Use the returned external ids with addigy_get_end_user_scim_credentials, addigy_update_end_user_scim, addigy_rotate_end_user_scim_token, or addigy_delete_end_user_scim_credentials. Paginated; response metadata has page/page_count/total. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Manage end users.
addigy_query_end_users details
addigy_query_end_users details
[Addigy] Query end users. Returns end-user records (id, display name, email, active state). Optional filters: group_ids (array — from addigy_query_end_user_groups), search (free-text), active (boolean), tenant_ids (array). Use addigy_get_end_user for a single full record. Paginated; response metadata has page/page_count/total. Requires organizationId from addigy_list_child_organizations. Requires API token permission: View end users.
addigy_rotate_end_user_scim_token details
addigy_rotate_end_user_scim_token details
[Addigy] Rotate (regenerate) the SCIM token for one integration. Returns the new SCIM credentials — the old token is invalidated, so update your identity provider afterward. Requires externalId (discover via addigy_query_end_user_scim_credentials). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Manage end users.
addigy_update_end_user_scim details
addigy_update_end_user_scim details
[Addigy] Update an existing SCIM integration used to provision end users. Requires externalId (the SCIM integration's external id — discover via addigy_query_end_user_scim_credentials). Required body field: `name` (display name, min length 1). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Manage end users.
Monitoring & Alerts
addigy_act_on_received_alerts details
addigy_act_on_received_alerts details
[Addigy] Perform a bulk action on received alerts within a specific organization: mute, acknowledge, or resolve. Required: organizationId (from addigy_list_child_organizations), action (mute|acknowledge|resolve), and a body with alert_ids (non-empty array). For action=mute, optionally include days_to_mute (integer, e.g. 7). Discover alert ids with addigy_query_received_alerts.
addigy_assign_monitoring_item_to_policy details
addigy_assign_monitoring_item_to_policy details
[Addigy] Assign a custom monitoring item to a policy so the check applies to that policy's devices. Required body fields: alert_id (the monitoring item id from addigy_query_monitoring_items), policy_id (the target policy id). Use addigy_unassign_monitoring_item_from_policy to reverse this. Requires API token permission: Edit Policy Monitoring.
addigy_create_monitoring_item details
addigy_create_monitoring_item details
[Addigy] Create a custom monitoring item (a fact-based check that raises alerts). Common fields: name, category, type, level, fact / fact_identifier, value / value_type, min_value / max_value, selector, emails (array), send_ticket, remediation_enabled, remediation_time, has_script, script_id, instructions. Returns the created item id. Use addigy_query_monitoring_items to list existing items and addigy_assign_monitoring_item_to_policy to scope it to a policy. Requires API token permission: Create Custom Monitoring.
addigy_delete_monitoring_item details
addigy_delete_monitoring_item details
[Addigy] Permanently delete a custom monitoring item by its id. Discover monitoring item ids with addigy_query_monitoring_items. Requires API token permission: Delete Custom Monitoring.
addigy_list_received_alerts details
addigy_list_received_alerts details
[Addigy] List received alerts (monitoring checks that have fired), optionally filtered by status. Returns the alert schedule with per-alert status and timing. For richer filtering (statuses, categories, date ranges, agent ids) use addigy_query_received_alerts. Paginated; response metadata carries page/page_count/total.
addigy_query_alert_level_stats details
addigy_query_alert_level_stats details
[Addigy] Aggregate received-alert counts grouped by alert level across organizations. Optional filter body: statuses[], ids[], name_contains (e.g. "disk"), remediation_status (Pending|Done|Failed), category, start_date / end_date (YYYY-MM-DD), agent_ids[]. Spans child organizations when multitenancy=true (optionally scoped to a child-organizations csv list).
addigy_query_alert_name_stats details
addigy_query_alert_name_stats details
[Addigy] Aggregate received-alert counts grouped by alert name across organizations. Optional filter body: statuses[], ids[], name_contains (e.g. "disk"), remediation_status (Pending|Done|Failed), category, start_date / end_date (YYYY-MM-DD), agent_ids[]. Spans child organizations when multitenancy=true (optionally scoped to a child-organizations csv list).
addigy_query_alert_remediation_stats details
addigy_query_alert_remediation_stats details
[Addigy] Aggregate received-alert counts grouped by remediation status across organizations. Optional filter body: statuses[], ids[], name_contains (e.g. "disk"), remediation_status (Pending|Done|Failed), category, start_date / end_date (YYYY-MM-DD), agent_ids[]. Spans child organizations when multitenancy=true (optionally scoped to a child-organizations csv list).
addigy_query_alert_status_stats details
addigy_query_alert_status_stats details
[Addigy] Aggregate received-alert counts grouped by alert status across organizations. Optional filter body: statuses[], ids[], name_contains (e.g. "disk"), remediation_status (Pending|Done|Failed), category, start_date / end_date (YYYY-MM-DD), agent_ids[]. Spans child organizations when multitenancy=true (optionally scoped to a child-organizations csv list).
addigy_query_alert_user_stats details
addigy_query_alert_user_stats details
[Addigy] Aggregate received-alert counts grouped by acknowledging/resolving user across organizations. Optional filter body: statuses[], ids[], name_contains (e.g. "disk"), remediation_status (Pending|Done|Failed), category, start_date / end_date (YYYY-MM-DD), agent_ids[]. Spans child organizations when multitenancy=true (optionally scoped to a child-organizations csv list).
addigy_query_monitoring_items details
addigy_query_monitoring_items details
[Addigy] List the organization's custom monitoring items, optionally filtered by id or a name-contains substring. Returns the item definitions (name, fact, thresholds, remediation settings). Use the returned ids with addigy_update_monitoring_item, addigy_delete_monitoring_item, or addigy_assign_monitoring_item_to_policy. Paginated; response metadata carries page/page_count/total.
addigy_query_received_alerts details
addigy_query_received_alerts details
[Addigy] Query received alerts across organizations with rich filtering and pagination. The nested query filter accepts: statuses[], ids[], name_contains (e.g. "disk"), remediation_status (Pending|Done|Failed), category, start_date / end_date (YYYY-MM-DD), agent_ids[]. Prefer this over addigy_list_received_alerts for filtered triage. Paginated; response metadata carries page/page_count/total. Spans child organizations when multitenancy=true (optionally scoped to a child-organizations csv list).
addigy_query_system_events details
addigy_query_system_events details
[Addigy] Search the organization's system-events audit stream (who did what, when — e.g. policy edits, command runs, device enrollments) with optional keyword highlighting and time-bucketed aggregation. Use addigy_search_system_events for the alternate /system-events/search surface. Paginated; response metadata carries page/page_count/total. Requires API token permission: View System Events.
addigy_search_system_events details
addigy_search_system_events details
[Addigy] Search the organization's system-events audit stream via the /system-events/search surface (alternate to addigy_query_system_events) with optional keyword highlighting and time-bucketed aggregation. Paginated; response metadata carries page/page_count/total. Requires API token permission: View System Events.
addigy_unassign_monitoring_item_from_policy details
addigy_unassign_monitoring_item_from_policy details
[Addigy] Remove a custom monitoring item from a policy (reverses addigy_assign_monitoring_item_to_policy). Both ids are required. Requires API token permission: Edit Policy Monitoring.
addigy_update_monitoring_item details
addigy_update_monitoring_item details
[Addigy] Update an existing custom monitoring item. The body must include the item id plus the fields to change. Common fields: id, name, category, type, level, fact, fact_identifier, value, value_type, min_value, max_value, selector, emails[], send_ticket, remediation_enabled, remediation_time, has_script, script_id, instructions, version. Discover ids with addigy_query_monitoring_items. Requires API token permission: Edit Custom Monitoring.
Software
addigy_assign_managed_app_config details
addigy_assign_managed_app_config details
[Addigy] Assigns (or unassigns) a managed app configuration to an Apple Apps & Books (VPP) application. Provide a JSON object. Properties: location_id (string), bundle_id (string), is_assigned (boolean — true to assign, false to unassign). Use addigy_get_managed_app_config to read the current assignment state.
addigy_assign_smart_software_to_policy details
addigy_assign_smart_software_to_policy details
[Addigy] Assigns a Smart Software item to a policy, given the organizationId, policyId and the Smart Software assetId. Discover organizationId via addigy_list_child_organizations, policy ids via the policies tools, and Smart Software asset ids via addigy_query_smart_software. Requires Addigy permission: Add Asset To Policy.
addigy_create_managed_app_config details
addigy_create_managed_app_config details
[Addigy] Creates a managed app configuration for an Apps & Books (VPP) application. Provide a JSON object. Properties: location_id (string), bundle_id (string), configuration (object map of key→Configuration), is_assigned (boolean), asset_id (string). Use addigy_get_managed_app_config / addigy_search_managed_app_configs afterward to read the stored config.
addigy_create_smart_software details
addigy_create_smart_software details
[Addigy] Creates a new Smart Software item in an organization. Pass the organizationId (from addigy_list_child_organizations) and a JSON body matching CreateSmartSoftwareRequest, optionally with a profiles array of PPPC profile objects. Use addigy_query_smart_software afterward to discover the new item's id. Requires Addigy permission: Create Smart Software.
addigy_create_smart_software_version details
addigy_create_smart_software_version details
[Addigy] Creates a new version of an existing Smart Software item. Pass the organizationId (from addigy_list_child_organizations), the Smart Software id (from addigy_query_smart_software), and a JSON body matching UpdateSmartSoftwareRequest, optionally with a profiles array of PPPC profile objects. Returns the updated CustomSoftware definition. Requires Addigy permission: Create Smart Software.
addigy_delete_managed_app_config details
addigy_delete_managed_app_config details
[Addigy] Deletes the managed app configuration for a single Apps & Books (VPP) application, identified by its locationId and the app's bundleId. Use addigy_search_managed_app_configs to confirm which configurations exist for a location before deleting.
addigy_delete_smart_software details
addigy_delete_smart_software details
[Addigy] Deletes a Smart Software item by id, scoped to an organization. Pass the organizationId (from addigy_list_child_organizations) and the Smart Software id (from addigy_query_smart_software or addigy_get_smart_software). Requires Addigy permission: Delete Smart Software.
addigy_get_managed_app_config details
addigy_get_managed_app_config details
[Addigy] Gets the managed app configuration for a single Apps & Books (VPP) application, identified by its locationId (VPP/Apps-and-Books location) and the app's bundleId (e.g. com.microsoft.Outlook). Returns the configuration key/value payload plus assignment flag and asset id. Use addigy_search_managed_app_configs to enumerate every managed app configuration for a location and discover bundle ids.
addigy_get_smart_software details
addigy_get_smart_software details
[Addigy] Gets a single Smart Software item by id, scoped to an organization. Pass the organizationId (from addigy_list_child_organizations) and the Smart Software id (from addigy_query_smart_software). Returns the full CustomSoftware definition. Requires Addigy permission: View Smart Software.
addigy_query_smart_software details
addigy_query_smart_software details
[Addigy] Gets a paginated list of Smart Software items, optionally filtered. Build the filter via queryJson — a JSON object supporting: archived (bool), name_contains (string), identifier (string — to fetch the versions of a specific software), ids (array), excluded_ids (array). Sort with sortField (default name) and sortDirection (asc|desc). Paginated; per_page max 100 per Addigy and response metadata carries page_count/total. Spans child organizations when multitenancy=true (optionally narrowed by childOrganizations). Use addigy_get_smart_software for full detail of a single item. Requires Addigy permission: View Smart Software.
addigy_query_vpp_token_policy_assignments details
addigy_query_vpp_token_policy_assignments details
[Addigy] Gets the list of Apps & Books (VPP) tokens assigned to a set of policies. Provide a JSON object with a policy_ids array (string policy ids). Returns an array of AppsAndBooksToken records. Spans child organizations when multitenancy=true (optionally narrowed by childOrganizations).
addigy_search_managed_app_configs details
addigy_search_managed_app_configs details
[Addigy] Gets all managed app configurations for an Apps & Books (VPP) location. Returns an array of configurations, each with its bundle_id, configuration payload, assignment flag and asset id. Use this to discover bundle ids before calling addigy_get_managed_app_config, addigy_assign_managed_app_config or addigy_delete_managed_app_config.
addigy_unassign_smart_software_from_policy details
addigy_unassign_smart_software_from_policy details
[Addigy] Unassigns a Smart Software item from a policy, given the organizationId, policyId and the Smart Software assetId. Discover organizationId via addigy_list_child_organizations and Smart Software asset ids via addigy_query_smart_software. Requires Addigy permission: Remove Asset From Policy.
Prebuilt Apps
addigy_create_prebuilt_app_config details
addigy_create_prebuilt_app_config details
[Addigy] Adds a Prebuilt App Configuration to a Policy — this is what actually deploys a Prebuilt App from the library to the Macs in a policy. Requires organizationId from addigy_list_child_organizations. Required body fields: policy_id (target policy), prebuilt_app_id (discover with addigy_query_prebuilt_apps), prebuilt_app_version_id (discover with addigy_query_prebuilt_app_versions), provider ("prebuilt-app" or "prebuilt-app-self-service"), enforcement_days (0-14, default 14). Optional: auto_update (default true), run_removal_script (default false), update_only (default false). Returns the created configuration. Requires API token permission: Add asset to policy.
addigy_delete_prebuilt_app_config details
addigy_delete_prebuilt_app_config details
[Addigy] Removes a Prebuilt App Configuration from a Policy — undeploys the Prebuilt App from that policy. Requires organizationId from addigy_list_child_organizations and the configuration id (discover with addigy_query_prebuilt_app_configs). This is irreversible; re-add with addigy_create_prebuilt_app_config. Requires API token permission: Remove asset from policy.
addigy_get_prebuilt_app details
addigy_get_prebuilt_app details
[Addigy] Gets a single app from the Prebuilt App library by its app ID. Returns the app's name, provider, categories, published state, and metadata. Discover app ids with addigy_query_prebuilt_apps; list its versions with addigy_query_prebuilt_app_versions. Requires API token permission: View Prebuilt Apps.
addigy_get_prebuilt_app_config details
addigy_get_prebuilt_app_config details
[Addigy] Gets a single Prebuilt App Configuration by its configuration ID. Returns the configuration's policy_id, prebuilt_app_id, prebuilt_app_version_id, provider, enforcement_days, auto_update, and related deployment settings. Requires organizationId from addigy_list_child_organizations and the configuration id (discover with addigy_query_prebuilt_app_configs). Requires API token permission: View Prebuilt Apps Configurations.
addigy_get_prebuilt_app_version details
addigy_get_prebuilt_app_version details
[Addigy] Gets a single app version from the Prebuilt App library by its version ID. Returns the version's app_id, version string, published_date, and metadata. Discover version ids with addigy_query_prebuilt_app_versions; the version id is required to pin a Prebuilt App Configuration via addigy_create_prebuilt_app_config. Requires API token permission: View Prebuilt Apps.
addigy_query_prebuilt_app_configs details
addigy_query_prebuilt_app_configs details
[Addigy] Queries Prebuilt App Configurations across organizations. Use this to discover configuration ids before addigy_get_prebuilt_app_config / addigy_update_prebuilt_app_config / addigy_delete_prebuilt_app_config. Pass a queryJson filter object to narrow results (any of: ids[], policy_ids[], prebuilt_app_ids[], prebuilt_app_version_ids[], provider (prebuilt-app|prebuilt-app-self-service), update_only, auto_update, assist_onboarding). Sort with sortField (id|policy_id|prebuilt_app_id|prebuilt_app_version_id) + sortDirection (asc|desc). Paginated; response metadata has page/page_count/total. Spans child organizations when multitenancy=true. Requires API token permission: View Prebuilt Apps Configurations.
addigy_query_prebuilt_app_versions details
addigy_query_prebuilt_app_versions details
[Addigy] Queries app versions in the Prebuilt App library to discover version ids (needed to pin a Prebuilt App Configuration via addigy_create_prebuilt_app_config). Pass a queryJson filter object to narrow results (any of: ids[], app_ids[], policy_ids[], version). Sort with sortField (id|app_id|version|published_date) + sortDirection (asc|desc). Paginated; response metadata has page/page_count/total. Requires API token permission: View Prebuilt Apps.
addigy_query_prebuilt_apps details
addigy_query_prebuilt_apps details
[Addigy] Queries the Prebuilt App library to discover available apps (and their app ids) for deployment via addigy_create_prebuilt_app_config. Pass a queryJson filter object to narrow results (any of: ids[], excluded_ids[], assigned_ids[], policy_ids[], categories[], name, provider (prebuilt-app|prebuilt-app-self-service), assist_onboarding, published, version_id). Sort with sortField + sortDirection (asc|desc). Paginated; response metadata has page/page_count/total. Requires API token permission: View Prebuilt Apps.
addigy_update_prebuilt_app_config details
addigy_update_prebuilt_app_config details
[Addigy] Updates an existing Prebuilt App Configuration (e.g. pin a new prebuilt_app_version_id, change enforcement_days or auto_update). Requires organizationId from addigy_list_child_organizations and the configuration id (discover with addigy_query_prebuilt_app_configs). Body fields (all optional): prebuilt_app_version_id, enforcement_days (0-14), auto_update, run_removal_script, update_only, assist_onboarding. Returns the updated configuration. Requires API token permission: Edit Prebuilt Apps Configurations.
Scripts & Maintenance
addigy_assign_maintenance_item_to_policy details
addigy_assign_maintenance_item_to_policy details
[Addigy] Assign a scheduled maintenance item to a policy so devices in that policy run it. Required body fields: `maintenance_id` (from addigy_query_maintenance_items) and `policy_id` (the target policy). Requires API token permission: Edit Policy Maintenance. Use addigy_unassign_maintenance_item_from_policy to reverse.
addigy_assign_os_user_to_policy details
addigy_assign_os_user_to_policy details
[Addigy] Assign an OS user asset to a policy. Requires organizationId (discover via addigy_list_child_organizations), the asset_id of the OS user, and the policy_id to assign it to. Requires API token permission: Add asset to policy. Use addigy_unassign_os_user_from_policy to reverse.
addigy_cancel_temp_admin_session details
addigy_cancel_temp_admin_session details
[Addigy] Cancel a scheduled or active TempAdmin session for a Mac user account. Requires organizationId (discover via addigy_list_child_organizations), agent_id (the device's Agent ID), and account_name (the macOS account). Requires API token permission: Manage Mac Users Privileges. Use addigy_schedule_temp_admin_session to (re)schedule.
addigy_create_device_script_assignment details
addigy_create_device_script_assignment details
[Addigy] Create a device script assignment — schedule a script (predefined command) to run on one or more devices in the organization. Required body fields: `script_id` (Script or Command ID from addigy_query_scripts) and `agent_ids` (array of Agent IDs of the target devices). Defaults to the API key's own organization; pass organizationId to target a specific child organization (discover IDs via addigy_list_child_organizations). Use addigy_list_device_script_assignments to confirm the assignment afterward.
addigy_create_maintenance_item details
addigy_create_maintenance_item details
[Addigy] Create a scheduled maintenance item (a recurring catalog maintenance task). Body properties include `name`, `description`, `frequency` (e.g. `Monthly`), `day` (e.g. `15`), `scheduled_time`, `enabled`, `local_time`, `prompt_user`, `timeout_seconds`, `max_try_count`, `expected_remediation_time`, `is_in_blueprint`, `version`, and `scripts` (array of {name, type, command_id, script}). Requires API token permission: Create Catalog Maintenance. Use addigy_query_maintenance_items to confirm afterward and addigy_assign_maintenance_item_to_policy to scope it to a policy.
addigy_create_scripts details
addigy_create_scripts details
[Addigy] Create one or more scripts (predefined commands) in an organization. Requires organizationId (discover via addigy_list_child_organizations). Body field `commands` is a required non-empty array of script objects; each script requires `name`, `text` (the script body), and `categories` (non-empty array of category names), with optional `description`, `created_date`, and `in_review`. Requires API token permission: Create Predefined Commands. Use addigy_query_scripts to discover the new script ids.
addigy_delete_device_script_assignment details
addigy_delete_device_script_assignment details
[Addigy] Delete a device script assignment — unschedule a script (predefined command) from a single device. Requires both script_id (Script or Command ID from addigy_query_scripts) and agent_id (the device's Agent ID). Defaults to the API key's own organization; pass organizationId to target a specific child organization (discover IDs via addigy_list_child_organizations). Use addigy_list_device_script_assignments to find existing assignments.
addigy_delete_maintenance_item details
addigy_delete_maintenance_item details
[Addigy] Delete a scheduled maintenance item by its id (from addigy_query_maintenance_items). Requires API token permission: Delete Catalog Maintenance.
addigy_delete_os_user details
addigy_delete_os_user details
[Addigy] Delete an OS User asset from an organization. Requires organizationId (discover via addigy_list_child_organizations) and the asset_id of the OS user. Requires API token permission: Delete OS Users.
addigy_delete_script details
addigy_delete_script details
[Addigy] Delete a script (predefined command) by id from an organization. Requires organizationId (discover via addigy_list_child_organizations) and the script id (discover via addigy_query_scripts). Requires API token permission: Delete Predefined Commands.
addigy_list_device_script_assignments details
addigy_list_device_script_assignments details
[Addigy] List device script assignments available for the organization — the mapping of scripts (predefined commands) to the specific devices they are scheduled to run on. Returns an array of assignments keyed by script_id and agent_id. Optionally filter to a single script (script_id from addigy_query_scripts) or a single device (agent_id, the device's Agent ID). Acts on the API key's own organization. Use addigy_create_device_script_assignment to add an assignment and addigy_delete_device_script_assignment to remove one.
addigy_query_maintenance_items details
addigy_query_maintenance_items details
[Addigy] Query the organization's scheduled maintenance items (recurring catalog maintenance — bundles of scripts run on a frequency). Returns a paginated list. Optional filters via filtersJson: `id` (exact maintenance id) and `name_contains` (substring match on name). Optional sort_field (e.g. `frequency`) and sort_direction (`asc`/`desc`). Paginated; response metadata carries page/page_count/total. Use addigy_create_maintenance_item to add one and addigy_update_maintenance_item / addigy_delete_maintenance_item to manage existing items.
addigy_query_scripts details
addigy_query_scripts details
[Addigy] Query the organization's scripts (predefined commands) and return a paginated list. Requires organizationId (discover via addigy_list_child_organizations). Optional filter via filtersJson: `ids` (array of script ids). Optional sort_field (e.g. `name`) and sort_order (`asc`/`desc`). Paginated (per_page max 100 upstream); response metadata carries page/page_count/total. Requires API token permission: View Predefined Commands. Use addigy_create_scripts to add scripts and addigy_delete_script to remove one.
addigy_schedule_temp_admin_session details
addigy_schedule_temp_admin_session details
[Addigy] Schedule (or update the schedule for) a TempAdmin session that temporarily promotes a Mac user account to admin. Requires organizationId (discover via addigy_list_child_organizations), agent_id (the device's Agent ID), and account_name (the macOS account to promote). Optional body fields: `start_time` and `end_time` (ISO8601, e.g. 2024-07-08T19:00:00Z), `device_local_time` (bool), and `reason` (e.g. 'Install Slack'). Requires API token permission: Manage Mac Users Privileges. Use addigy_cancel_temp_admin_session to cancel.
addigy_unassign_maintenance_item_from_policy details
addigy_unassign_maintenance_item_from_policy details
[Addigy] Unassign a scheduled maintenance item from a policy. Requires the maintenance id (from addigy_query_maintenance_items) and the policy_id. Requires API token permission: Edit Policy Maintenance. Use addigy_assign_maintenance_item_to_policy to re-assign.
addigy_unassign_os_user_from_policy details
addigy_unassign_os_user_from_policy details
[Addigy] Unassign an OS user asset from a policy. Requires organizationId (discover via addigy_list_child_organizations), the asset_id of the OS user, and the policy_id to unassign it from. Requires API token permission: Remove asset from policy. Use addigy_assign_os_user_to_policy to re-assign.
addigy_update_maintenance_item details
addigy_update_maintenance_item details
[Addigy] Update an existing scheduled maintenance item. Body must include `id` (the maintenance id from addigy_query_maintenance_items) plus the fields to change: `name`, `description`, `frequency`, `day`, `scheduled_time`, `enabled`, `local_time`, `prompt_user`, `timeout_seconds`, `max_try_count`, `expected_remediation_time`, `is_in_blueprint`, `version`, and `scripts` (array of {name, type, command_id, script}). Requires API token permission: Edit Catalog Maintenance.
System Updates
addigy_email_installed_updates_report details
addigy_email_installed_updates_report details
[Addigy] Requests that an installed-system-updates report for a policy's devices be generated and emailed to a recipient. This is an asynchronous side-effecting action (it sends an email), not a synchronous data fetch — for inline data on one device use addigy_get_device_installed_updates_report. Body fields: `policy_id` (the Addigy policy whose devices to report on) and `email` (the recipient address). Requires API token permission: View System Updates Settings.
addigy_get_available_system_updates_status details
addigy_get_available_system_updates_status details
[Addigy] Returns the OS software updates reported as available for a single device, each annotated with its current installation status (e.g. scheduled, downloading, installing, installed, failed). Combines the available-update list from addigy_list_available_system_updates with per-update progress. Requires the device's MDM UDID. Requires API token permission: View Device List, Execute Predefined Commands.
addigy_get_device_installed_updates_report details
addigy_get_device_installed_updates_report details
[Addigy] Returns the history of OS software updates already installed on a single device, as reported via MDM. Use this to audit patch level / confirm an update applied after scheduling it. Note: this endpoint keys off the device UUID (the Addigy device identifier), not the MDM UDID used by the request/status tools. For the same data across all devices in a policy delivered by email, use addigy_email_installed_updates_report. Requires API token permission: View System Updates Settings, View Device List.
addigy_get_system_updates_settings details
addigy_get_system_updates_settings details
[Addigy] Returns the configured system-updates settings for a policy — the per-OS (macOS/iOS/iPadOS/tvOS) update enforcement rules and the optional daily-send schedule. Use this to inspect current configuration before changing it with addigy_set_system_updates_settings. Requires the Addigy policy id. Requires API token permission: View System Updates Settings.
addigy_get_system_updates_status details
addigy_get_system_updates_status details
[Addigy] Returns the current system-updates statuses most recently reported for a single device (the live progress of in-flight OS updates). Reads the cached/last-reported statuses; to force the device to re-report, first call addigy_request_system_updates_status. Requires the device's MDM UDID. Requires API token permission: View Device List, Execute Predefined Commands.
addigy_list_available_system_updates details
addigy_list_available_system_updates details
[Addigy] Returns the OS software updates most recently reported as available for a single device. Reads the cached/last-reported list; to force the device to re-report, first call addigy_request_available_system_updates (or addigy_request_system_updates_scan). For each available update with its current install status, use addigy_get_available_system_updates_status instead. Requires the device's MDM UDID. Requires API token permission: View Device List.
addigy_request_available_system_updates details
addigy_request_available_system_updates details
[Addigy] Issues an MDM command asking a device to report the OS software updates it currently has available. This is a write/command action — it queues an MDM command rather than returning the cached list (use addigy_list_available_system_updates to read the previously-reported results, or addigy_get_available_system_updates_status to read results with their install statuses). Required body field: `device_udid` (the device's MDM UDID). Requires API token permission: View Device List, Execute Predefined Commands.
addigy_request_system_updates_scan details
addigy_request_system_updates_scan details
[Addigy] Issues an MDM command telling a device to scan for newly-available OS software updates, refreshing what addigy_list_available_system_updates / addigy_get_available_system_updates_status will return. Required body field: `device_udid` (the device's MDM UDID). Optional: `force` (boolean — bypass any cached scan result and force a fresh scan). Requires API token permission: View Device List, Execute Predefined Commands.
addigy_request_system_updates_schedule details
addigy_request_system_updates_schedule details
[Addigy] Issues an MDM command scheduling a specific OS software update to install on a single device. Use this to push one known update (discovered via addigy_list_available_system_updates) with a chosen install behavior, rather than the bulk on-demand tools. Required body fields: `device_udid` (the device's MDM UDID), `product_key` (the update's product key from the available-updates list), and `install_action` (one of: Default, DownloadOnly, InstallASAP, NotifyOnly, InstallLater, InstallForceRestart). Optional: `product_version`, `description`. Requires API token permission: View Device List, Execute Predefined Commands.
addigy_request_system_updates_status details
addigy_request_system_updates_status details
[Addigy] Issues an MDM command asking a device to report its current system-updates statuses, refreshing what addigy_get_system_updates_status will return. This is a write/command action that queues an MDM command rather than returning the statuses inline. Required body field: `device_udid` (the device's MDM UDID). Requires API token permission: View Device List, Execute Predefined Commands.
addigy_schedule_updates_for_devices details
addigy_schedule_updates_for_devices details
[Addigy] Sends on-demand MDM system-update commands immediately to a specific list of devices, rather than waiting for the default daily 2AM UTC schedule. Body field: `device_uuids` (array of Addigy device UUIDs to update now). To target a whole policy instead, use addigy_schedule_updates_for_policy. Applies to MDM system updates only; the organization must have a monthly paid plan to use this feature. Requires API token permission: View System Updates Settings, Create System Updates Settings.
addigy_schedule_updates_for_policy details
addigy_schedule_updates_for_policy details
[Addigy] Sends on-demand MDM system-update commands immediately to every device in a policy, rather than waiting for the default daily 2AM UTC schedule. Body field: `policy_id` (the Addigy policy whose devices to update now). To target a hand-picked device list instead, use addigy_schedule_updates_for_devices. Applies to MDM system updates only; the organization must have a monthly paid plan to use this feature. Requires API token permission: View System Updates Settings, Create System Updates Settings.
addigy_set_system_updates_settings details
addigy_set_system_updates_settings details
[Addigy] Creates or updates the system-updates settings for a policy, covering both MDM and Declarative Device Management (DDM) enforcement across macOS/iOS/iPadOS/tvOS, plus an optional send schedule. MDM enforcement needs supervised devices on macOS 12+/iOS 9+/iPadOS 13+/tvOS 12+; DDM needs supervised macOS 14+/iOS 17+/iPadOS 17+. Body field `policy_id` selects the target policy; `macos_settings`/`ios_settings`/`ipados_settings`/`tvos_settings` carry the per-OS rules (e.g. keep_os_updated, install_action, max_user_deferrals, deferrals, automatic_actions, denied_period, allowed_days); `schedule` controls the optional non-default send window (set schedule.enabled=false to keep the daily 2AM UTC default; if enabled, all schedule fields are required and the org must have a monthly paid plan). Fetch the current shape with addigy_get_system_updates_settings first. Requires API token permission: Create System Updates Settings.
Self Service
addigy_create_self_service_config details
addigy_create_self_service_config details
[Addigy] Creates a new Self Service configuration in the organization. Supply a JSON body describing the configuration — common fields include `name`, `label`, `description`, `os_type`, `display_mode`, `grace_period` (integer), home-screen branding (`home_screen_company_name`, `home_screen_email`, `home_screen_phone`, `home_screen_address`, `home_screen_description`, and their `home_screen_show_*` boolean toggles), prompt text fields (`maintenance_prompt_text`, `filevault_prompt_text`, `screenview_prompt_text`, `user_sentiment_prompt_text`, `ms_office_updates_prompt_text`), icon/logo file objects (`app_logo`, `dark_mode_app_logo`, `dock_icon`, `menubar_icon`), and behavior toggles (`show_support`, `hide_chat`, `restart_after_complete`, `show_complete_screen`, `beta_program_enabled`, `is_onboarding_config`, `policy_restricted`, `allow_location_tracking`, `integration_intune_enabled`, `instruction_id`). Use addigy_get_policy_self_service_configs to inspect existing assignments. Requires API token permission: Create Instruction.
addigy_get_policy_self_service_configs details
addigy_get_policy_self_service_configs details
[Addigy] Get the Self Service configurations assigned by OS for a policy, aggregated across child organizations. Requires policyId. Returns the per-OS Self Service configuration assignments for that policy. Spans child organizations when multitenancy=true; use childOrganizations to target specific child org IDs.
addigy_query_self_service_location_assets details
addigy_query_self_service_location_assets details
[Addigy] Gets a list of available Self Service assets for the provided location IDs (token IDs), aggregated across child organizations. Supply a JSON body to scope the query — example fields: `location_ids` (array of location/token ID strings), `policy_ids` (array of policy ID strings — discover policy IDs via addigy_get_policy_self_service_configs and related policy tools), `device_family` (string), `is_onboarding` (boolean). Spans child organizations when multitenancy=true; use childOrganizations to target specific child org IDs.
addigy_update_self_service_config details
addigy_update_self_service_config details
[Addigy] Updates an existing Self Service configuration in the organization. Supply a JSON body with the updated configuration — same field set as addigy_create_self_service_config, including the target configuration's `instruction_id`. Common fields: `name`, `label`, `description`, `os_type`, `display_mode`, `grace_period` (integer), home-screen branding (`home_screen_`), prompt text fields (`_prompt_text`), icon/logo file objects (`app_logo`, `dark_mode_app_logo`, `dock_icon`, `menubar_icon`), and behavior toggles (`show_support`, `hide_chat`, `restart_after_complete`, `beta_program_enabled`, `is_onboarding_config`, etc.). Requires API token permission: Create Instruction.
Compliance & Benchmarks
addigy_assign_benchmark_to_policy details
addigy_assign_benchmark_to_policy details
[Addigy] Assign a benchmark to a policy so the policy's devices are scored against it. Body properties: policy_id, benchmark_id. Discover benchmark ids with addigy_query_benchmarks and policy ids via the Addigy policy tools. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Edit Policy Benchmarks.
addigy_create_benchmark details
addigy_create_benchmark details
[Addigy] Create a new benchmark asset (a named OS-version + compliance-rule set used for device compliance scoring). Returns the created benchmark including its id. Body properties: name, target_os, minimum_os_version, maximum_os_version, compliance_rules_ids (array of compliance-rule ids from addigy_query_compliance_rules). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Create Benchmark.
addigy_create_compliance_rule details
addigy_create_compliance_rule details
[Addigy] Create a compliance rule (an audit filter set, optionally with an auto-remediation script, that benchmarks reference for device compliance scoring). Returns the created rule including its id. Body properties: name, description, filter_sets (array of arrays of AuditFilter objects), remediation_enabled (boolean), agent_remediation_script_id (the script to run when non-compliant). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Create Benchmark.
addigy_delete_benchmark details
addigy_delete_benchmark details
[Addigy] Delete a benchmark asset by id. Discover benchmark ids with addigy_query_benchmarks. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Delete Benchmark.
addigy_delete_compliance_rule details
addigy_delete_compliance_rule details
[Addigy] Delete a compliance rule by id. Check whether a rule is still in use first with addigy_get_compliance_rule_usage. Discover compliance-rule ids with addigy_query_compliance_rules. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Delete Benchmark.
addigy_get_azure_ca_tenants_metadata details
addigy_get_azure_ca_tenants_metadata details
[Addigy] Get metadata for the unique, enabled Azure Conditional Access tenants. Returns an array of account-metadata objects (one per distinct tenant). Use this to discover the policy ids and tenants to feed into addigy_query_azure_ca_accounts_metadata and addigy_query_azure_ca_account_status. Spans child organizations when multitenancy=true.
addigy_get_compliance_rule_usage details
addigy_get_compliance_rule_usage details
[Addigy] Get usage details for a single compliance rule — which benchmarks reference it. Use this before deleting a rule with addigy_delete_compliance_rule to confirm nothing depends on it. Discover compliance-rule ids with addigy_query_compliance_rules. Spans child organizations when multitenancy=true. Requires API token permission: View Benchmarks.
addigy_list_compliance_rules_using_script details
addigy_list_compliance_rules_using_script details
[Addigy] List the compliance rules that reference a given remediation script. Use this before deleting or editing a script to see which compliance rules depend on it. Discover script ids via the Addigy scripts/maintenance tools. Requires organizationId from addigy_list_child_organizations. Requires API token permission: View Benchmarks.
addigy_query_azure_ca_account_status details
addigy_query_azure_ca_account_status details
[Addigy] Get Azure Conditional Access status for accounts tied to the given policy ids. If a global account exists, its status is always returned. Body property: policy_ids (array of strings). Spans child organizations when multitenancy=true.
addigy_query_azure_ca_accounts_metadata details
addigy_query_azure_ca_accounts_metadata details
[Addigy] Get Azure Conditional Access metadata for all accounts tied to the given policy ids. Body property: policy_ids (array of strings). Discover Azure CA tenant metadata with addigy_get_azure_ca_tenants_metadata. Spans child organizations when multitenancy=true.
addigy_query_benchmarks details
addigy_query_benchmarks details
[Addigy] Search/list benchmark assets for an organization. This is the primary discovery tool for benchmark ids used by addigy_update_benchmark, addigy_delete_benchmark, and addigy_assign_benchmark_to_policy. Optional query filter (queryJson) supports name_contains, ids (array), and excluded_ids (array). Paginated; response metadata carries page/page_count/per_page/total. Spans child organizations when multitenancy=true. Requires API token permission: View Benchmarks.
addigy_query_compliance_rules details
addigy_query_compliance_rules details
[Addigy] Search/list compliance rules for an organization. This is the primary discovery tool for compliance-rule ids used by addigy_create_benchmark, addigy_update_benchmark, addigy_update_compliance_rule, and addigy_delete_compliance_rule. Optional query filter (queryJson) supports name_contains, ids (array), and excluded_ids (array). Paginated; response metadata carries page/page_count/per_page/total. Spans child organizations when multitenancy=true. Requires API token permission: View Benchmarks.
addigy_unassign_benchmark_from_policy details
addigy_unassign_benchmark_from_policy details
[Addigy] Remove a benchmark from a policy so the policy's devices are no longer scored against it. Discover benchmark ids with addigy_query_benchmarks and policy ids via the Addigy policy tools. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Edit Policy Benchmarks.
addigy_update_benchmark details
addigy_update_benchmark details
[Addigy] Update an existing benchmark asset (the named OS-version + compliance-rule set used for device compliance scoring). Pass the full benchmark object — the body's `id` field identifies which benchmark to update. Body properties: id (required, the benchmark id from addigy_query_benchmarks), name, target_os, minimum_os_version, maximum_os_version, compliance_rules_ids (array of compliance-rule ids from addigy_query_compliance_rules). Requires organizationId from addigy_list_child_organizations. Requires API token permission: Edit Benchmark.
addigy_update_compliance_rule details
addigy_update_compliance_rule details
[Addigy] Update an existing compliance rule. The body's `id` field identifies which rule to update. Body properties: id (required, from addigy_query_compliance_rules), name, description, filter_sets (array of arrays of AuditFilter objects), remediation_enabled (boolean), agent_remediation_script_id. Requires organizationId from addigy_list_child_organizations. Requires API token permission: Edit Benchmark.
Integrations
addigy_assign_mbov_site_to_policy details
addigy_assign_mbov_site_to_policy details
[Addigy] Assigns a MalwareBytes OneView (MBOV) site to a policy. Optional body fields: mbov_site_id (discover via addigy_list_mbov_sites), policy_id (the Addigy policy identifier). Requires the organizationId (discover via addigy_list_child_organizations). Use addigy_list_mbov_policy_sites to verify the assignment and addigy_unassign_mbov_site_from_policy to reverse it.
addigy_close_device_ticket details
addigy_close_device_ticket details
[Addigy] Closes a single device ticket. Idempotent — closing an already-closed ticket is a no-op. Requires the organizationId (discover via addigy_list_child_organizations), the device agent_id, and the ticket_id (discover via addigy_list_device_tickets). Requires API token permission: Edit Tickets.
addigy_create_ticket_note details
addigy_create_ticket_note details
[Addigy] Adds an organization note to a ticket. Returns the created TicketNote. Required body field: `message` (string). Requires the organizationId (discover via addigy_list_child_organizations) and the ticket_id (discover via addigy_list_device_tickets). Use addigy_list_ticket_notes to read existing notes.
addigy_disable_mbov_integration details
addigy_disable_mbov_integration details
[Addigy] Disables the MalwareBytes OneView (MBOV) integration for an organization. Destructive — tears down the MBOV account linkage. Requires the organizationId (discover via addigy_list_child_organizations). Use addigy_enable_mbov_integration to re-enable.
addigy_enable_mbov_integration details
addigy_enable_mbov_integration details
[Addigy] Enables the MalwareBytes OneView (MBOV) integration for an organization, creating a new MBOV account. Returns the resulting AccountStatus. Optional body fields: email, billing_street, billing_city, billing_state, billing_zip_code, billing_country (all strings). Requires the organizationId (discover via addigy_list_child_organizations). Use addigy_get_mbov_account_status to check the resulting account state and addigy_disable_mbov_integration to reverse this.
addigy_get_autotask_account details
addigy_get_autotask_account details
[Addigy] Retrieves a single Autotask PSA account (company) by its account_id. Returns the Account object. Requires the organizationId (discover via addigy_list_child_organizations) and the account_id (discover via addigy_list_autotask_accounts).
addigy_get_connectwise_account details
addigy_get_connectwise_account details
[Addigy] Retrieves a single ConnectWise PSA account (company) by its account_id. Returns the Account object. Requires the organizationId (discover via addigy_list_child_organizations) and the account_id (discover via addigy_list_connectwise_accounts).
addigy_get_mbov_account_status details
addigy_get_mbov_account_status details
[Addigy] Returns the MalwareBytes OneView (MBOV) account status for an organization (whether the integration is enabled and its provisioning state). Requires the organizationId (discover via addigy_list_child_organizations). Use addigy_get_mbov_account_usage for catalog-code usage figures.
addigy_get_mbov_account_usage details
addigy_get_mbov_account_usage details
[Addigy] Returns MalwareBytes OneView (MBOV) catalog-code usage for an organization across a date window. Both start_date and end_date are required in YYYY-MM-DD format (passed through verbatim). Requires the organizationId (discover via addigy_list_child_organizations). Use addigy_get_mbov_account_status for the integration's enabled/provisioning state.
addigy_list_autotask_accounts details
addigy_list_autotask_accounts details
[Addigy] Lists the Autotask PSA accounts (companies) available to the Autotask integration for an organization. Returns an array of Account objects. Optionally narrow results with a free-text search phrase. Requires the organizationId (discover via addigy_list_child_organizations). Use addigy_get_autotask_account for a single account's detail.
addigy_list_connectwise_accounts details
addigy_list_connectwise_accounts details
[Addigy] Lists the ConnectWise PSA accounts (companies) available to the ConnectWise integration for an organization. Returns an array of Account objects. Optionally narrow results with a free-text search phrase. Requires the organizationId (discover via addigy_list_child_organizations). Use addigy_get_connectwise_account for a single account's detail.
addigy_list_device_tickets details
addigy_list_device_tickets details
[Addigy] Lists all support tickets attached to a single device within an organization. Returns an array of Ticket objects (id, status, subject, timestamps). Requires the organizationId (discover via addigy_list_child_organizations) and the device agent_id (the device's Addigy agent identifier, discoverable via the device-listing tools). Use addigy_list_ticket_notes to read a ticket's conversation and addigy_close_device_ticket to close one.
addigy_list_mbov_policy_sites details
addigy_list_mbov_policy_sites details
[Addigy] Lists the MalwareBytes OneView (MBOV) sites assigned to a specific policy. Returns an array of Site objects. Requires the organizationId (discover via addigy_list_child_organizations) and the policy_id (the Addigy policy identifier). Use addigy_list_mbov_sites for the full site catalog and addigy_assign_mbov_site_to_policy / addigy_unassign_mbov_site_from_policy to change assignments.
addigy_list_mbov_sites details
addigy_list_mbov_sites details
[Addigy] Lists the MalwareBytes OneView (MBOV) sites available to an organization's MBOV account. Returns an array of Site objects. Requires the organizationId (discover via addigy_list_child_organizations). Use addigy_list_mbov_policy_sites to see which sites are assigned to a specific policy and addigy_assign_mbov_site_to_policy to assign one.
addigy_list_ticket_notes details
addigy_list_ticket_notes details
[Addigy] Lists the notes (conversation entries) on a ticket. Returns an array of TicketNote objects. The required include_internal flag controls whether internal-only notes are returned (true) or only customer-visible notes (false). Requires the organizationId (discover via addigy_list_child_organizations) and the ticket_id (discover via addigy_list_device_tickets). Use addigy_create_ticket_note to add an organization note.
addigy_sync_autotask_policy_devices details
addigy_sync_autotask_policy_devices details
[Addigy] Triggers a sync of a policy's devices with their mapped Autotask configurations. Required body field: `policy_id` (string). Requires the organizationId (discover via addigy_list_child_organizations). Requires API token permission: Edit Integration.
addigy_sync_connectwise_policy_devices details
addigy_sync_connectwise_policy_devices details
[Addigy] Triggers a sync of a policy's devices with their mapped ConnectWise configurations. Required body field: `policy_id` (string). Requires the organizationId (discover via addigy_list_child_organizations). Requires API token permission: Edit Integration.
addigy_unassign_mbov_site_from_policy details
addigy_unassign_mbov_site_from_policy details
[Addigy] Removes a MalwareBytes OneView (MBOV) site from a policy. Destructive — unlinks the site from the policy. Requires the organizationId (discover via addigy_list_child_organizations) and the policy_id. Use addigy_assign_mbov_site_to_policy to re-assign and addigy_list_mbov_policy_sites to inspect current assignments.
Variables & Static Fields
addigy_assign_static_field_to_devices details
addigy_assign_static_field_to_devices details
[Addigy] Assign a static field value to one or more devices. Required body fields: `static_field_id` (from addigy_list_static_fields), `agent_ids` (array of device/agent ids), and `value` (the value to set on those devices). Example: {"static_field_id":"sf_123","agent_ids":["agent1","agent2"],"value":"Floor 3"}. Verify assignments afterward with addigy_list_device_static_field_values. Requires API token permission: View Devices.
addigy_assign_variable_policy_value details
addigy_assign_variable_policy_value details
[Addigy] Assign a policy-specific override value to a variable, so devices in that policy resolve the variable to this value instead of the organization default. Required body fields: `policy_id`, `variable_key`, and `value` (the override). Example: {"policy_id":"abc123","variable_key":"company_name","value":"Acme West"}. Requires organizationId from addigy_list_child_organizations; discover policies with addigy_list_policies and keys with addigy_query_variables. Requires API token permission: Edit Policy.
addigy_create_static_fields details
addigy_create_static_fields details
[Addigy] Create a new static field for the organization. Required body field: `name` (the field name). Example: {"name":"Asset Tag"}. Returns the created field id, which you then assign to devices via addigy_assign_static_field_to_devices. List existing fields with addigy_list_static_fields. Requires API token permission: View Devices.
addigy_create_variable details
addigy_create_variable details
[Addigy] Create a new organization variable. Required body fields: `key` (variable name) and `type` ("string" or "secret"; secret values are masked). Optional: `default_value` (organization-wide default). Example: {"key":"api_endpoint","type":"string","default_value":"https://example.com"}. Requires organizationId from addigy_list_child_organizations. Returns the created variable. Requires API token permission: Create Variable.
addigy_delete_static_field details
addigy_delete_static_field details
[Addigy] Remove a static field from the organization by its id. Permanently deletes the field and its per-device values. Required: `id` (from addigy_list_static_fields). Requires API token permission: View Devices.
addigy_delete_variable details
addigy_delete_variable details
[Addigy] Delete an organization variable by its key. Permanently removes the variable and any policy-level overrides assigned to it (discover overrides first with addigy_get_variable_policy_value). Requires organizationId from addigy_list_child_organizations and the variable `key` from addigy_query_variables. Requires API token permission: Delete Variable.
addigy_get_variable_policy_value details
addigy_get_variable_policy_value details
[Addigy] List policy-level override values for variables in an organization. Returns an array of variable-policy associations (each with policy id, variable key, and the override value). Requires organizationId from addigy_list_child_organizations. Optionally filter by `policyId` (from addigy_list_policies) and/or `variableKey` (from addigy_query_variables); omit both to list all overrides. To read a single resolved value use addigy_get_variable_value_by_policy. Requires API token permission: Edit Policy.
addigy_get_variable_usage details
addigy_get_variable_usage details
[Addigy] List where a variable is referenced across the organization (the assets/objects that consume it). Returns an array of usage records for the given variable key. Required: `variableKey` (from addigy_query_variables) and organizationId from addigy_list_child_organizations. Useful before addigy_delete_variable to assess impact. Requires API token permission: View Variable.
addigy_get_variable_value details
addigy_get_variable_value details
[Addigy] Resolve a variable's organization-default value (ignoring any policy overrides). Required: `variableKey` (from addigy_query_variables) and organizationId from addigy_list_child_organizations. For the policy-scoped value use addigy_get_variable_value_by_policy. Requires API token permission: View Variable.
addigy_get_variable_value_by_policy details
addigy_get_variable_value_by_policy details
[Addigy] Resolve a single variable's value as it applies within a specific policy (returns the policy override if one exists, otherwise the organization default). Required: `variableKey` (from addigy_query_variables), `policyId` (from addigy_list_policies), and organizationId from addigy_list_child_organizations. For the organization-default value (ignoring policy) use addigy_get_variable_value. Requires API token permission: View Variable.
addigy_list_device_static_field_values details
addigy_list_device_static_field_values details
[Addigy] List static field values assigned to devices across the organization (each record pairs a device/agent with a static field and its value). Paginated; response metadata has page_count/total. Discover field ids with addigy_list_static_fields; assign new values with addigy_assign_static_field_to_devices. Requires API token permission: View Devices.
addigy_list_static_fields details
addigy_list_static_fields details
[Addigy] List all static fields defined for the organization (each with its id and name). Paginated; response metadata has page_count/total. Use the returned field id with addigy_assign_static_field_to_devices, addigy_update_static_field, or addigy_delete_static_field. To see which devices have values assigned, use addigy_list_device_static_field_values. Requires API token permission: View Devices.
addigy_query_variables details
addigy_query_variables details
[Addigy] Search/list organization variables. POST-based query: optionally filter via queryJson with `keys` (array of exact keys) and/or `key_contains` (substring), e.g. {"key_contains":"company"}. Paginated; response metadata has page_count/total. Sort with sortField/sortDirection. Spans child organizations when multitenancy=true (use childOrganizations to scope to specific child org ids). This is the discovery tool for variable keys consumed by addigy_get_variable_value, addigy_update_variable, and addigy_delete_variable. Requires API token permission: View Variables.
addigy_unassign_variable_policy_value details
addigy_unassign_variable_policy_value details
[Addigy] Remove a policy-level override value from a variable, reverting that policy to the variable's organization default. Requires organizationId from addigy_list_child_organizations, `policyId` (from addigy_list_policies), and `variableKey` (from addigy_query_variables). Inspect current overrides first with addigy_get_variable_policy_value. Requires API token permission: Edit Policy.
addigy_update_static_field details
addigy_update_static_field details
[Addigy] Update (rename) an existing static field for the organization. Required body fields: `id` (static field id from addigy_list_static_fields) and `name` (the new field name). Example: {"id":"sf_123","name":"Asset Tag"}. Static fields are custom name/value attributes you can assign to devices via addigy_assign_static_field_to_devices. Requires API token permission: View Devices.
addigy_update_variable details
addigy_update_variable details
[Addigy] Update an existing organization variable's default value. Required body field: `key` (the variable to update). Optional: `default_value` (the new organization-wide default). Example: {"key":"company_name","default_value":"Acme Inc"}. Requires organizationId from addigy_list_child_organizations; discover keys with addigy_query_variables. Returns the updated variable. Requires API token permission: Edit Variable.
Files, Exports & Reports
addigy_delete_file details
addigy_delete_file details
[Addigy] Delete a file from an organization, identified by its file_id. Requires organizationId (from addigy_list_child_organizations, or the org's own id) and the fileId — discover file ids with addigy_query_files or addigy_get_file_metadata. This permanently removes the file. Requires API token permission: Delete Files.
addigy_download_export_source details
addigy_download_export_source details
[Addigy] Export the raw data of a source over a date range. These sources often contain a daily snapshot of data for every day between date_start and date_end. Discover sourceId with addigy_list_export_sources. This endpoint is not paginated and can return a large amount of data — keep the date range narrow for best results. dateStart/dateEnd must be formatted as YYYY-MM-DD (e.g. 2024-12-01). Spans child organizations when multitenancy=true. Requires API token permission: Export Report Data.
addigy_get_file_metadata details
addigy_get_file_metadata details
[Addigy] Get an organization file's metadata by its id — name, md5_hash, size, upload date, and related fields. Discover file ids with addigy_query_files. Spans child organizations when multitenancy=true. Requires API token permission: View Files.
addigy_get_report details
addigy_get_report details
[Addigy] Get a generated report by its report_id. Discover report ids from the response of addigy_request_report or by checking addigy_query_report_statuses. Spans child organizations when multitenancy=true.
addigy_list_available_reports details
addigy_list_available_reports details
[Addigy] Get the list of reports available to be requested. Returns an array of report definitions (type, name, supported formats). Use a returned type with addigy_request_report to generate that report. Spans child organizations when multitenancy=true.
addigy_list_export_sources details
addigy_list_export_sources details
[Addigy] List the data sources available to be exported. A source is the raw data for a specific entity within Addigy. Returns each source's id and metadata — use the id with addigy_download_export_source to download that source's raw data over a date range. Spans child organizations when multitenancy=true. Requires API token permission: Export Report Data.
addigy_query_files details
addigy_query_files details
[Addigy] Get a paginated list of organization files. All body fields are optional filters: ids (array of file id strings), search_term (string), md5_hash (array of hash strings), plus pagination (page, per_page) and sorting (sort_field, sort_direction). For one file's full metadata use addigy_get_file_metadata. Paginated; response metadata has page/page_count/total. Spans child organizations when multitenancy=true. Requires API token permission: View Files.
addigy_query_report_statuses details
addigy_query_report_statuses details
[Addigy] Get the status of one or more reports. Required body field: report_ids (array of strings, at least one — from addigy_request_report). Returns each report's status so you can tell when it is ready to fetch with addigy_get_report. Spans child organizations when multitenancy=true.
addigy_request_report details
addigy_request_report details
[Addigy] Request a report be generated for an organization. Only one report of each type can be requested at a time. Requires organizationId (from addigy_list_child_organizations, or the org's own id). Required body field: type (string — the report type; discover available types with addigy_list_available_reports). Optional body fields: format (csv|json), payload (object of report-specific parameters), email_settings (object with recipients and cc_recipients string arrays). Returns the report status — poll with addigy_query_report_statuses and fetch the finished report with addigy_get_report.
Community
addigy_get_community_fact details
addigy_get_community_fact details
[Addigy] Get a single community-shared custom fact by its id. Returns the community fact's full detail. Discover fact ids with addigy_query_community_facts or addigy_list_featured_community_facts. Spans child organizations when multitenancy=true; scope with childOrganizations.
addigy_get_community_script details
addigy_get_community_script details
[Addigy] Get a single community-shared script by its id. Returns the community script's full detail. Discover script ids with addigy_query_community_scripts or addigy_list_featured_community_scripts. Spans child organizations when multitenancy=true; scope with childOrganizations.
addigy_list_featured_community_facts details
addigy_list_featured_community_facts details
[Addigy] Get featured community facts — the highest rated, most voted, most copied, and newest community-shared facts. Returns a curated array of featured facts. Use addigy_query_community_facts to search the full catalog, or addigy_get_community_fact for one fact's detail. Spans child organizations when multitenancy=true; scope with childOrganizations.
addigy_list_featured_community_scripts details
addigy_list_featured_community_scripts details
[Addigy] Get featured community scripts — the highest rated, most voted, most copied, and newest community-shared scripts. Returns a curated array of featured scripts. Use addigy_query_community_scripts to search the full catalog, or addigy_get_community_script for one script's detail. Spans child organizations when multitenancy=true; scope with childOrganizations.
addigy_query_community_facts details
addigy_query_community_facts details
[Addigy] Get a paginated list of community-shared facts. Optional filter (via queryJson) supports `fact_id_author`, `submitter_emails` (array of strings), `search_text` (substring), and `ids` (array of fact ids). Supports sort_fields (via sortFieldsJson — JSON array of field names) and sort_direction (asc/desc). per_page is capped at 100 by the API. Use addigy_get_community_fact for one fact's detail. Spans child organizations when multitenancy=true; scope with childOrganizations. Paginated; pass page to walk results.
addigy_query_community_scripts details
addigy_query_community_scripts details
[Addigy] Get a paginated list of community-shared scripts. Optional filter (via queryJson) supports `script_id_author`, `submitter_emails` (array of strings), `search_text` (substring), and `ids` (array of script ids). Supports sort_fields (via sortFieldsJson — JSON array of field names) and sort_direction (asc/desc). per_page is capped at 100 by the API. Use addigy_get_community_script for one script's detail. Spans child organizations when multitenancy=true; scope with childOrganizations. Paginated; pass page to walk results.
addigy_report_community_content details
addigy_report_community_content details
[Addigy] Report a community fact or command to Addigy for review (e.g. inappropriate or broken content). Requires organizationId (from addigy_list_child_organizations). Body fields (all required): `id` (the community fact or command id — discover facts with addigy_query_community_facts / addigy_get_community_fact and scripts with addigy_query_community_scripts / addigy_get_community_script), `report_reason` (free-text reason), and `type` (one of `custom-fact` | `predefined-command`).
Webhooks
addigy_create_webhook details
addigy_create_webhook details
[Addigy] Create a webhook for an organization. Required body field: name (string). Optional: action (object with required url — the endpoint Addigy POSTs events to), trigger (object describing which events fire it: sender_type, sender_name, sender_identifier, receiver_type, receiver_name, receiver_identifier, action_name, action_entity_type, action_entity_name, action_entity_identifier, result_status, level), disabled (boolean). Returns the created Webhook record (including its id). Requires organizationId from addigy_list_child_organizations (or the org's own id). To change an existing webhook use addigy_update_webhook; to list them use addigy_query_webhooks.
addigy_delete_webhook details
addigy_delete_webhook details
[Addigy] Delete a webhook from an organization, identified by its webhook id. Discover existing webhook ids with addigy_query_webhooks. This permanently removes the webhook subscription — to re-create one use addigy_create_webhook. Requires organizationId from addigy_list_child_organizations (or the org's own id).
addigy_delete_webhook_schedule details
addigy_delete_webhook_schedule details
[Addigy] Delete the delivery schedule of a webhook, identified by its webhook id — clears the pending (queued) events waiting to be sent for that webhook. Discover webhook ids with addigy_query_webhooks; check pending/resolved event counts with addigy_get_webhook_event_count first. This does not delete the webhook itself (use addigy_delete_webhook for that). Requires organizationId from addigy_list_child_organizations (or the org's own id).
addigy_get_webhook_event_count details
addigy_get_webhook_event_count details
[Addigy] Returns the count of events resolved (already sent) and/or pending (waiting to be sent) for specific webhooks. Required body field: webhook_ids (array of strings) — discover ids with addigy_query_webhooks. Optional: statuses (array) limiting the count to particular states: "resolved" (event successfully sent) and/or "pending" (event awaiting dispatch). Use addigy_delete_webhook_schedule to clear pending events. Spans child organizations when multitenancy=true.
addigy_query_webhook_statuses details
addigy_query_webhook_statuses details
[Addigy] Get the delivery statuses of webhooks. Returns an array of WebhookStatus records describing the current health/state of each webhook's deliveries. Pass an optional JSON body to narrow the result: webhook_ids (array of strings) restricts to specific webhook ids — discover them with addigy_query_webhooks. For raw pending/resolved event tallies use addigy_get_webhook_event_count. Spans child organizations when multitenancy=true.
addigy_query_webhooks details
addigy_query_webhooks details
[Addigy] Get the list of webhooks configured for an organization. Returns an array of Webhook records (id, name, action url, trigger, disabled). Pass an optional JSON body to narrow the result: ids (array of strings) restricts to specific webhook ids. Omit the body (or pass an empty object) to return all webhooks. These ids are what addigy_get_webhook_event_count, addigy_query_webhook_statuses, addigy_update_webhook, and addigy_delete_webhook consume. Spans child organizations when multitenancy=true.
addigy_update_webhook details
addigy_update_webhook details
[Addigy] Update an existing webhook, matched by its id. Required body fields: id (string, identifies the webhook to update — from addigy_query_webhooks) and name (string). Optional: action (object with required url), trigger (sender_type, sender_name, sender_identifier, receiver_type, receiver_name, receiver_identifier, action_name, action_entity_type, action_entity_name, action_entity_identifier, result_status, level), disabled (boolean). Returns the updated Webhook record. Requires organizationId from addigy_list_child_organizations (or the org's own id). To create a webhook use addigy_create_webhook; to remove one use addigy_delete_webhook.
More in Tools Reference
Atera ToolsAuvik ToolsAvanan (Check Point Harmony Email) ToolsConnectWise Sell ToolsStill need help? Ask the team