Addigy actions & Endpoints
Become familiar with the actions available to use with your Addigy integration
Last updated
Was this helpful?
Become familiar with the actions available to use with your Addigy integration
Last updated
Was this helpful?
The Addigy Integration with Rewst delivers a robust set of actions and endpoints for interacting with Addigy. Below is a summary of each section, highlighting the diverse capabilities and opportunities provided through the Addigy Integration:
POST api.addigy.com/v2/oa/apps-and-books/tokens/policies/query
Get a list of apps and books tokens assigned to policies.
POST api.addigy.com/v2/oa/ade/tokens/policies/query
Get a list of ade tokens assigned to policies.
GET api.addigy.com/v2/o/{organization_id}/integrations/autotask/accounts
Get Autotask account.
GET api.addigy.com/v2/o/{organization_id}/integrations/autotask/accounts/{account_id}
Get Autotask account.
POST api.addigy.com/v2/o/{organization_id}/integrations/autotask/policy/device/sync
Sync policy devices with Autotask configurations. **Permission Required*: *Edit Integration.
POST api.addigy.com/v2/oa/integrations/azure-ca/accounts/metadata/query
Get Azure Conditional Access all accounts metadata.
PUT api.addigy.com/v2/o/{organization_id}/benchmarks
Update a benchmark asset. **Permission Required*: *Edit Benchmark.
POST api.addigy.com/v2/o/{organization_id}/benchmarks
Create a benchmark asset. **Permission Required*: *Create Benchmark.
DELETE api.addigy.com/v2/o/{organization_id}/benchmarks
Delete a benchmark asset.**Permission Required*: *Delete Benchmark.
POST api.addigy.com/v2/o/{organization_id}/policy/assets/benchmarks
Assign a benchmark to a policy. **Permission Required: Edit Policy Benchmarks.
DELETE api.addigy.com/v2/o/{organization_id}/policy/assets/benchmarks
Remove a benchmark from a policy. **Permission Required: Edit Policy Benchmarks.
POST api.addigy.com/v2/oa/benchmarks/query
Get a list of benchmark assets for an organization. **Permission Required*: *View Benchmarks.
GET api.addigy.com/v2/o/{organization_id}/billing/account
Get billing account for a given organization.
GET api.addigy.com/v2/o/{organization_id}/billing/data
Get billing data for a given child organization.
GET api.addigy.com/v2/o/{organization_id}/billing/invoices
Get billing invoices for a given organization.
GET api.addigy.com/v2/o/{organization_id}/children/query
Get a list of child organizations belonging to the provided organization
POST api.addigy.com/v2/o/{organization_id}/devices/commands/run
Run devices command.
GET api.addigy.com/v2/o/{organization_id}/devices/{agent_id}/commands/{action_id}/output
Get command output.
POST api.addigy.com/v2/o/{organization_id}/community/report
Report a community fact or command to Addigy for review.
PUT api.addigy.com/v2/o/{organization_id}/compliance-rules
Update a compliance rule. **Permission Required*: *Edit Benchmark.
POST api.addigy.com/v2/o/{organization_id}/compliance-rules
Create a compliance rule. **Permission Required*: *Create Benchmark.
DELETE api.addigy.com/v2/o/{organization_id}/compliance-rules
Delete a compliance rule.**Permission Required*: *Delete Benchmark.
GET api.addigy.com/v2/o/{organization_id}/compliance-rules/scripts
Get compliance rules using script. **Permission Required: View Benchmarks.
POST api.addigy.com/v2/oa/compliance-rules/query
Get a list of compliance rules for an organization. **Permission Required*: *View Benchmarks.
GET api.addigy.com/v2/oa/compliance-rules/usage
Get a compliance rule usage. **Permission Required*: *View Benchmarks.
GET api.addigy.com/v2/configuration/permissions
Get API key permissions
GET api.addigy.com/v2/o/{organization_id}/integrations/connectwise/accounts
Get ConnectWise account.
GET api.addigy.com/v2/o/{organization_id}/integrations/connectwise/accounts/{account_id}
Get ticketing account.
POST api.addigy.com/v2/o/{organization_id}/integrations/connectwise/policy/device/sync
Sync policy devices with ConnectWise configurations. **Permission Required*: *Edit Integration.
GET api.addigy.com/v2/o/{organization_id}/device/compliance/benchmark/status
Get device compliance statuses per benchmark. **Permission Required*: *View devices.
POST api.addigy.com/v2/oa/devices/compliance/status/query
Get devices compliance status. **Permission Required: View Devices.
GET api.addigy.com/v2/device-script-assignments
Get Device Script Assignments available for the organization.
POST api.addigy.com/v2/device-script-assignments
Creates a device script assignment in the organization.
DELETE api.addigy.com/v2/device-script-assignments
Deletes a device script assignment from the organization.
POST api.addigy.com/v2/devices
Allow to query for a set of devices based on a value that pertains to one of their device facts. **Permission Required*: *View Devices.
DELETE api.addigy.com/v2/o/{organization_id}/devices/{sn}
Removes a device from Addigy **Permission Required: Delete Devices. **Note: This endpoint is not meant to be used by bulk removal operations.
GET api.addigy.com/v2/facts/custom
List all custom facts for the organization.
PUT api.addigy.com/v2/facts/custom
Update a custom fact.
POST api.addigy.com/v2/facts/custom
Create a custom fact.
DELETE api.addigy.com/v2/facts/custom
Delete a custom fact.
POST api.addigy.com/v2/facts/custom/policy
Assign Custom Facts to policies.
DELETE api.addigy.com/v2/facts/custom/policy
Unassign a custom fact from a policy.
POST api.addigy.com/v2/facts/custom/query
Get a list of Custom Facts filtered by id or name for an organization.
POST api.addigy.com/v2/oa/files/query
Get a list of files for an organization. **Permission Required: View Files.
GET api.addigy.com/<url_path>
Include /v2/ for Addigy API v2 usage, generic action for making authenticated requests against the Addigy API
POST api.addigy.com/v2/oa/installed-apps/mdm/query
Query installed apps from a device providing some agent IDs. **Permission Required: View Devices.
PUT api.addigy.com/v2/maintenance
Update a maintenance item. **Permission Required*: *Edit Catalog Maintenance.
POST api.addigy.com/v2/maintenance
Create a maintenance item. **Permission Required*: *Create Catalog Maintenance.
DELETE api.addigy.com/v2/maintenance
Delete a maintenance item.**Permission Required*: *Delete Catalog Maintenance.
POST api.addigy.com/v2/maintenance/policy
Assign polices to a maintenance item. **Permission Required: Edit Policy Maintenance.
DELETE api.addigy.com/v2/maintenance/policy
Unassign a maintenance item from policy. **Permission Required*: *Edit Policy Maintenance.
POST api.addigy.com/v2/maintenance/query
Get a list of maintenance items for an organization.
POST api.addigy.com/v2/o/{organization_id}/integrations/mbov
Enable MalwareBytes OneView integration. Create new account.
DELETE api.addigy.com/v2/o/{organization_id}/integrations/mbov
Disable MalwareBytes OneView integration.
GET api.addigy.com/v2/o/{organization_id}/integrations/mbov/account/status
Get MalwareBytes OneView account status
GET api.addigy.com/v2/o/{organization_id}/integrations/mbov/account/usage
Get MalwareBytes OneView account catalog usage
GET api.addigy.com/v2/o/{organization_id}/integrations/mbov/sites
Get MalwareBytes OneView sites
GET api.addigy.com/v2/o/{organization_id}/policy/mbov-sites
Get MalwareBytes OneView policy sites.
POST api.addigy.com/v2/o/{organization_id}/policy/mbov-sites
Assign a MalwareBytes OneView site to a policy.
DELETE api.addigy.com/v2/o/{organization_id}/policy/mbov-sites
Remove a MalwareBytes OneView site from policy.
GET api.addigy.com/v2/managed-app-configurations
Gets managed app configuration for Apps & Books applications.
POST api.addigy.com/v2/managed-app-configurations
Requests to create managed app configuration for Apps & Books applications.
DELETE api.addigy.com/v2/managed-app-configurations
Requests to delete managed app configuration for Apps & Books applications.
PUT api.addigy.com/v2/managed-app-configurations/assign
Requests to assign managed app configuration to Apple application.
GET api.addigy.com/v2/managed-app-configurations/search
Gets managed app configurations for a location.
DELETE api.addigy.com/v2/mdm/commands/device-passcode
This command allows the server to delete a user that has an active account on the device.Please provide the device agent ID or the device UUID
DELETE api.addigy.com/v2/mdm/commands/device-user
This command allows the server to delete a user that has an active account on the device.Please provide the device agent ID or the device UUID
GET api.addigy.com/v2/mdm/commands/device-users/query
Returns a list of known users that were given to Addigy via the Request User List command. Please provide the device agent ID or the device uuid
POST api.addigy.com/v2/mdm/commands/device/lock
This command locks the device. The device will be unusable until the passcode is entered.Please provide the device agent ID or the device UUID
POST api.addigy.com/v2/mdm/commands/device/lost-mode/disable
This command allows the server to put the device in MDM lost mode, with a message, phone number, and footnote text. A message or phone number must be provided.Please provide the device agent ID or the device UUID
POST api.addigy.com/v2/mdm/commands/device/lost-mode/enable
This command allows the server to put the device in MDM lost mode, with a message, phone number, and footnote text. A message or phone number must be provided.Please provide the device agent ID or the device UUID
POST api.addigy.com/v2/mdm/commands/device/lost-mode/location
Allows the server to ask the device to report its location if it is in MDM lost mode. Please provide the device agent ID or the device UUID.
POST api.addigy.com/v2/mdm/commands/device/restart
Description coming soon...
GET api.addigy.com/v2/mdm/configurations/definition/{addigy_payload_type}
Addigy payload type of MDM profile
GET api.addigy.com/v2/mdm/configurations/definitions
Get MDM configuration profile definitions
GET api.addigy.com/v2/mdm/configurations/policy/profiles
Get policy profiles by Addigy payload type
POST api.addigy.com/v2/mdm/configurations/profile
Creates an MDM profile.Permission Required*: *Create MDM Profiles.Requirements: The payload must be a valid MDM payload. We do not support profiles with multiple payloads at this time. Use payload_display_name, payload_type, payload_priority, and the required payload keys as outlined in the Apple Documentation for the payload that you are trying to create. Payload: This is what each field represents within the payload and which are the allowed values for the request.payload_display_name - represents the name of the payload to be created,payload_type - represents the type of payload as defined in the Apple Documentation, such as com.apple.airplay,payload_priority - represents the priority order in which the profile will be sent to the device, once the policy runs, default value is 9 (Facts: 2, Self Service: 2, Splashtop: 5, MS Office Update: 10, Software: 10, OS Users: 10, System Update: 20).For more information about Addigy's API Supported MDM payloads, please visit [Addigy's API Supported MDM Payloads](https:support.addigy.comhcen-usarticles29982135947411)
POST api.addigy.com/v2/mdm/configurations/profile/policies
Assign policies to manifest-based MDM configuration profile
DELETE api.addigy.com/v2/mdm/configurations/profile/policies
Unassign an MDM profile from policies
GET api.addigy.com/v2/mdm/configurations/profile/{payload_group_id}
Get manifest-based MDM configuration profile
DELETE api.addigy.com/v2/mdm/configurations/profile/{payload_group_id}
Delete manifest-based MDM configuration profile
GET api.addigy.com/v2/mdm/configurations/profiles
Get manifest-based MDM configuration profiles
PUT api.addigy.com/v2/mdm/configurations/profiles/stage
Update a manifest-based MDM configuration profile
POST api.addigy.com/v2/mdm/configurations/profiles/stage
Confirm changes to manifest-based MDM configuration profile
POST api.addigy.com/v2/o/{organization_id}/mdm/payloads/query
Query MDM Payload information and assignments
GET api.addigy.com/v2/mdm/devices/{device_uuid}
Get MDM device details including enrollment profile, APN certificate and last response.
GET api.addigy.com/v2/mdm/devices/{device_uuid}/test
Test MDM response.
POST api.addigy.com/v2/o/{organization_id}/mdm/enrollment/profile/install
Install MDM enrollment profile via mdm if available or via agent for macOS devices
POST api.addigy.com/v2/mdm/certificates/query
Paginated request that returns list of installed certificates by mdm devices. **Permission Required*: *View Devices
POST api.addigy.com/v2/mdm/devices/profile/deploy
Deploys profile to list of devices andor managed users. It is an atomic request meaning that if one error is encountered no profile will be deployed to any of the devices andor managed users.Permission Required: View Devices, Execute commands
GET api.addigy.com/v2/mdm/profiles
Description coming soon...
POST api.addigy.com/v2/mdm/profiles/policies
Get MDM profiles assigned to policies
PUT api.addigy.com/v2/monitoring
Update a monitoring item. **Permission Required*: *Edit Custom Monitoring.
POST api.addigy.com/v2/monitoring
Create a monitoring item. **Permission Required*: *Create Custom Monitoring.
DELETE api.addigy.com/v2/monitoring
Delete a monitoring item.**Permission Required*: *Delete Custom Monitoring.
POST api.addigy.com/v2/monitoring/policy
Assign monitoring item to policy. **Permission Required: Edit Policy Monitoring.
DELETE api.addigy.com/v2/monitoring/policy
Unassign a monitoring item from policy. **Permission Required*: *Edit Policy Monitoring.
POST api.addigy.com/v2/monitoring/query
Get a list of monitoring items for an organization.
GET api.addigy.com/v2/oa/monitoring/received-alerts
Query list of received alerts
POST api.addigy.com/v2/o/{organization_id}/policies/{policy_id}/office-updates/{asset_id}
Assign office asset to policy. **Permission Required: Edit Policy Instruction.
DELETE api.addigy.com/v2/o/{organization_id}/policies/{policy_id}/office-updates/{asset_id}
Remove office update from a policy. **Permission Required: Edit Policy Instruction.
POST api.addigy.com/v2/o/{organization_id}/policies/{policy_id}/os-users/{asset_id}
Assigns an OS user asset to a policy. **Permission Required: Edit Policy Instructions.
DELETE api.addigy.com/v2/o/{organization_id}/policies/{policy_id}/os-users/{asset_id}
Unassigns an OS user asset from a policy. **Permission Required*: *Edit Policy Instructions.
PUT api.addigy.com/v2/o/{organization_id}/policies
Update a policy. **Permission Required*: *Edit Policy.
POST api.addigy.com/v2/o/{organization_id}/policies
Create a policy. **Permission Required*: *Create Policy.
DELETE api.addigy.com/v2/o/{organization_id}/policies
Delete a policy. **Permission Required*: *Delete Policy.
PUT api.addigy.com/v2/o/{organization_id}/policies/parent
Update a policy parent. **Permission Required*: *Edit Policy.
DELETE api.addigy.com/v2/o/{organization_id}/policies/parent
Delete a policy parent. **Permission Required*: *Edit Policy.
POST api.addigy.com/v2/oa/policies/query
Query an organization for all policies or filter to get specific policy info
GET api.addigy.com/v2/o/{organization_id}/policies/rule
Get policy assignment rule. **Permission Required: .Automatic Policy Assignments
POST api.addigy.com/v2/o/{organization_id}/policies/rule
Add assignment rule to policy. **Permission Required: Automatic Policy Assignments.
DELETE api.addigy.com/v2/o/{organization_id}/policies/rule
Remove assignment rule from policy. **Permission Required: Automatic Policy Assignments.
GET api.addigy.com/v2/o/{organization_id}/policies/rules
Get policy assignment rules. **Permission Required: .Automatic Policy Assignments
GET api.addigy.com/v2/feature-betas
Get all Beta Features available for the organization. **Permission Required*: *Toggle Feature Betas.
POST api.addigy.com/v2/feature-betas/organizations
Enables a Beta Feature in the organization. **Permission Required*: *Toggle Feature Betas.
DELETE api.addigy.com/v2/feature-betas/organizations
Disables the Beta Features from the organization. **Permission Required*: *Toggle Feature Betas.
POST api.addigy.com/v2/o/{organization_id}/reports
Request a report. Only one report of each type can be requested at a time.
GET api.addigy.com/v2/oa/reports
Get a report.
GET api.addigy.com/v2/oa/reports/available
Get a list of available reports.
POST api.addigy.com/v2/oa/reports/status/query
Get report statuses.
DELETE api.addigy.com/v2/o/{organization_id}/scripts
Delete a script. **Permission Required*: *Delete Predefined Commands.
POST api.addigy.com/v2/self-service-configurations
Creates a new self service configuration in the organization. **Permission Required*: *Create Instruction.
POST api.addigy.com/v2/oa/policies/self_service/location/assets/query
Description coming soon...
POST api.addigy.com/v2/o/{organization_id}/policies/{policy_id}/smart-software/{asset_id}
Assigns a Smart Software Item to a Policy given the Policy ID and Smart Software Item ID. Permission Required: Edit Policy Instructions.
DELETE api.addigy.com/v2/o/{organization_id}/policies/{policy_id}/smart-software/{asset_id}
Unassigns a Smart Software Item from a Policy given the Policy ID and Smart Software Item ID. Permission Required: Edit Policy Instructions.
POST api.addigy.com/v2/o/{organization_id}/smart-software
Creates a new smart software Permission Required: Create Instruction.
POST api.addigy.com/v2/o/{organization_id}/smart-software/query
Gets a list of smart software items available for the given organization.Items returned can be filtered based on query parameters from the request.To query for the versions of a software, provide the identifier of the software in the query.
GET api.addigy.com/v2/o/{organization_id}/smart-software/{id}
Gets a smart software item by ID.
POST api.addigy.com/v2/o/{organization_id}/smart-software/{id}/new-version
Creates a new version of a smart software Permission Required: Create Instruction.
GET api.addigy.com/v2/static-fields
Gets a list of all static fields available for the organization. **Permission Required*: *View Devices.
PUT api.addigy.com/v2/static-fields
Updates the name of an existing static field in the organization. **Permission Required*: *View Devices.
POST api.addigy.com/v2/static-fields
Creates a new static field in the organization. **Permission Required*: *View Devices.
DELETE api.addigy.com/v2/static-fields
Removes the static field from the organization. **Permission Required*: *View Devices.
GET api.addigy.com/v2/static-fields/value
Gets a list of all static fields assigned to devices for the organization. **Permission Required*: *View Devices.
POST api.addigy.com/v2/static-fields/value
Assign static field values to device(s) in the organization. **Permission Required*: *View Devices.
POST api.addigy.com/v2/events/query
Allows listing system events with highlighting. **Permission Required*: *View System Events.
POST api.addigy.com/v2/system-events/search
Allow to search system events. **Permission Required: View System Events.
GET api.addigy.com/v2/system-updates/available
Gets available system updates reported for a device.Permission Required*: *View Device List.
POST api.addigy.com/v2/system-updates/available
Requests available system updates for a device via MDM command.Permission Required*: *View Device List, Execute Predefined Commands.
GET api.addigy.com/v2/system-updates/available/status
Gets available system updates reported for a device, with their current installation statuses.Permission Required*: *View Device List, Execute Predefined Commands.
GET api.addigy.com/v2/system-updates/installed/device/report
Gets installed system updates reported for a device.Permission Required*: *[View System Updates Settings, View Device List].
POST api.addigy.com/v2/system-updates/installed/organization/report/email
Requests to send installed system updates reported for policy devices to user email.**Permission Required*: *View System Updates Settings.
POST api.addigy.com/v2/system-updates/on-demand/device-uuids
Requests to schedule system updates (on-demand) for devices via MDM command.Permission Required*: *[View System Updates Settings, Create System Updates Settings][MDM System Updates Only] System Updates commands are scheduled to be sent daily at 2AM UTC, but you can send them now to the device(s) on this list. Please note that your organization must have a monthly paid plan to use this feature.
POST api.addigy.com/v2/system-updates/on-demand/policy-id
Requests to schedule system updates (on-demand) for policy devices via MDM command.Permission Required*: *[View System Updates Settings, Create System Updates Settings][MDM System Updates Only] System Updates commands are scheduled to be sent daily at 2AM UTC, but you can send them now to the device(s) in this policy. Please note that your organization must have a monthly paid plan to use this feature.
POST api.addigy.com/v2/system-updates/scan
Requests a system updates scan for a device via MDM command.Permission Required*: *View Device List, Execute Predefined Commands.
POST api.addigy.com/v2/system-updates/schedule
Requests the schedule of system updates via MDM command.Permission Required*: *View Device List, Execute Predefined Commands.
GET api.addigy.com/v2/system-updates/settings
Gets system updates settings for a policy.Permission Required*: *View System Updates Settings.
POST api.addigy.com/v2/system-updates/settings
Requests to create or update system updates settings for a policy.Permission Required*: *Create System Updates Settings.Requirements: The MDM update command only works with macOS 12+, iOS 9+, iPadOS 13+, or tvOS 12+. Devices must be in supervised mode. Unsupervised devices will not receive the update command.Minor Updates and Patches: Use version values to control which major, minor or patch updates are sent. Addigy will strictly follow your rules. Version values follow the major.minor.patch standard.For example: 12.0.99 will allow patches, but not the minor update to 12.1, 12.9.9 will not allow 12.9.91.System Updates Settings: This is what each of the more specialized fields represents within the system updates settings for each os and which are the allowed values for the request.install_action - represents the install action when sending the schedule os command to the device: 1.Default (all OS) 2.InstallForceRestart (macOS Only) 3.InstallLater (macOS Only),max_user_deferrals - represents how many times the user can defer the updates, this is an optional parameter and it only works when 'Install Action' is 'InstallLater' and for minor os updates,resend_update_command_hour - The time in hours needed to re-send an os update command if the last command status is older than this value. Currently, the default value is 24 hours and the valid values ranges from 1 hour up to 24,days_after_release, hours_after_release and minutes_after_release (DDM updates only): The number of days, hours and minutes to force an update installation via DDM, after the update is released.Schedule (excludes updates via DDM): System Updates commands are scheduled to be sent daily at 2AM UTC, but you can schedule them to run on the device's time and which days of the week. The schedule is optional, if you would like to continue to use the default daily schedule, just set the schedule. enabled field to false. However, if you would like to opt in to use the schedule, just set the schedule.enabled field to true and fill all fields since they are required as part of the schedule request. Please note that your organization must have a monthly paid plan to use this feature.This is what each field represents and what are the allowed values for the schedule request:enabled - represents if the schedule is enabled or disabled (true or false),week_days - represents days of the week ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"],starting_time - represents the schedule starting time (hours: 0-23h, min: 0 or 30),cut_off_time - represents last time within the maintenance window to send updates commands to the devices (min: 30, 45, 60),maintenance_window - represents how long do the schedule runs for in 2x hour intervals (hours: 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24).For more information about System Updates please visit [System Updates via MDM](https:support.addigy.comhcen-usarticles10073419654931)
GET api.addigy.com/v2/system-updates/status
Gets current system updates statuses reported for a device.Permission Required*: *View Device List, Execute Predefined Commands.
POST api.addigy.com/v2/system-updates/status
Requests system updates statuses for a device via MDM command.Permission Required*: *View Device List, Execute Predefined Commands.
POST api.addigy.com/v2/o/{organization_id}/users/query
Query for organization users. **Permission Required*: *View Users.
PUT api.addigy.com/v2/users
Update a user. **Permission Required*: *Edit User.
POST api.addigy.com/v2/users
Create a user. **Permission Required*: *Create User.
DELETE api.addigy.com/v2/users
Deletes a user from the organization. **Permission Required*: *Remove User.
PUT api.addigy.com/v2/o/{organization_id}/variables
Update a variable. **Permission Required*: *Edit Variable.
POST api.addigy.com/v2/o/{organization_id}/variables
Create a variable. **Permission Required*: *Create Variable.
DELETE api.addigy.com/v2/o/{organization_id}/variables
Delete a variable.**Permission Required*: *Delete Variable.
GET api.addigy.com/v2/o/{organization_id}/variables/policies
Get policy variable value. **Permission Required*: *Edit Policy.
POST api.addigy.com/v2/o/{organization_id}/variables/policies
Assign policy value to a variable. **Permission Required: Edit Policy.
DELETE api.addigy.com/v2/o/{organization_id}/variables/policies
Remove policy value from a variable. **Permission Required: Edit Policy.
GET api.addigy.com/v2/o/{organization_id}/variables/usage
Get variable usage. **Permission Required*: *View Variable.
GET api.addigy.com/v2/o/{organization_id}/variables/value
Get variable value.**Permission Required*: *View Variable.
POST api.addigy.com/v2/oa/variables/query
Get a list of variables for an organization. **Permission Required*: *View Variables.