API Documentation (v2) – Addigy

Addigy API v2 supersedes Addigy API v1. If you are still using API v1, use the Migration Guide to switch to API v2.

Authenticating

Permissions needed

To view, create, and delete API keys the following Addigy user permissions are necessary:

View Integrations API Keys
Create Integrations API Keys
Delete Integrations API Keys

Getting an API Key

Navigate to Account > Integrations > API & Webhooks.
In the Addigy API section's V2 tab, click New API Token.
Choose the permissions you wish to allow for this API token. Use the rule of least privilege, giving the API key only the permissions needed to achieve what you need.
Copy the token and store it in a secure location. You will NOT be able to access the key again inside Addigy.

Copy the token and store it in a secure location. You will NOT be able to access the API key again inside Addigy.

Try out the API

Visit the API v2 documentation.
Click "Authorize" and enter your API Token in the Value field.
Find and toggle open the API endpoint you wish to test and choose "Try it out". Be sure the token you created has the appropriate permissions for the API calls you wish to use.

Rate Limiting

The number of requests made to the API are rate limited to 1,000 requests per 10 seconds. If that rate limit is exceeded, further requests will be rejected for 24 hours following the rate limit being exceeded.

HTTP Methods

Method	Definition
GET	The `GET` method requests a single record or list for the specified resource.
POST	The `POST` method is used for both: Creating of resources Getting resources using complex queries.
PUT	The `PUT` method updates the specified resource.
DELETE	The `DELETE` method deletes the specified resource.

Error Codes

Code	Response
200	OK
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden (Permissions are likely missing)
500	Server error

Pagination

Many of the Addigy API calls can return a large amount of data. When this the case, the response is paginated to limit the amount of data returned in each call. This is the case for most endpoints that return lists.

On each call to the API you are provided with the total number of pages of data. You can iterate through them by specifying which page and number of items per page you would like on each request until you reach the last page.

The following properties are used in the body or query parameters for endpoints that are paginated or their defaults will apply.

Parameter	Description	Default
per_page	Number of items to return per page	50
page	Number of the current page you would like to retrieve items for	1

Paginated endpoints will not return all records. If you need all records to perform a function, you should use the metadata returned with the response to calculate and iterate over pages based on total results to get full list of items.

"metadata": {
    "page": 1,
    "page_count": 10,
    "per_page": 10,
    "result_count": 10,
    "total": 100
  }

Device Facts

Device Fact Name	Type
32_bit_applications	list
active_users	list
addigy_splashtop_installed	boolean
admin_users	list
agent_version	string
bandwidth_saved_gb	number
bandwidth_served_gb	number
battery_capacity_loss_percentage	number
battery_charging	boolean
battery_cycles	number
battery_failures	number
battery_percentage	number
battery_temperature_fahrenheit	number
battery_temperature_celsius	number
bluetooth_mac	string
build_version	string
crashplan_days_since_last_backup	number
current_user	string
device_chip_type	string
device_model_name	string
device_name	string
display_on	boolean
displays_serial_number	string
enrolled_via_dep	boolean
ethernet_mac_address	string
files_served	number
filevault_enabled	boolean
firewall_allowed_applications	list
firewall_block_all_incoming_connections	boolean
firewall_blocked_applications	list
firewall_enabled	boolean
firewall_stealth_mode_enabled	boolean
firmware_password_allow_orams	boolean
firmware_password_exists	boolean
free_disk_percentage	number
free_disk_space_gb	number
gatekeeper_enabled	boolean
has_mdm	boolean
has_mdm_profile_approved	boolean
has_wireless	boolean
host_name	string
identity_installed	boolean
identity_users	list
installed_profiles	list
is_apple_intelligence_compatible	boolean
is_mdm_client_stuck	boolean
is_mdm_identity_certificate_installed	boolean
is_mdm_softwareupdated_stuck	boolean
is_sequoia_ready	boolean
is_sonoma_ready	boolean
java_vendor	string
java_version	string
kernel_panic	boolean
lan_cache_size_bytes	number
last_reboot_timestamp	date
local_ip	string
locales	string
localhost_name	string
mac_os_x_version	string
mb_endpoint_account_id	string
mb_endpoint_agent_version	string
mb_endpoint_machine_id	string
mb_endpoint_nebula_machine_id	string
mb_oneview_installed	boolean
mdm_update_eligibility	boolean
microsoft_company_portal_version	string
os_platform	string
os_version	string
peer_count	number
policy_execution_seconds	number
privileged_mdm	boolean
processor_speed_ghz	number
processor_type	string
product_description	string
product_name	string
remote_desktop_enabled	boolean
remote_login_enabled	boolean
serial_number	string
smart_failing	boolean
software_update_device_id	string
splashtop_id	string
splashtop_installation_date	date
splashtop_version	string
system_integrity_protection_enabled	boolean
system_version	string
third_party_agents	list
third_party_daemons	list
third_party_kernel_extensions	list
time_machine_days_since_last_backup	number
timezone	string
tmp_size_mb	number
total_disk_space_gb	number
total_memory_gb	number
udid	string
uptime_days	number
used_memory_gb	number
warranty_days_left	number
wifi_mac_address	string
xcode_installed	boolean
battery_health	string
agentid	string
audit_execution_time_seconds	number
azure_ad_device_ids	list
azure_ad_user_ids	list
client_ip	string
filevault_key_escrowed	boolean
identity_email	string
identity_employee_department	string
identity_employee_hire_date	string
identity_employee_type	string
identity_job_title	string
identity_mobile_phone	string
identity_office_location	string
identity_password_last_set_date	date
identity_provider_name	string
identity_usage_location	string
identity_user_display_name	string
identity_username	string
is_compliant	boolean
last_online	date
mac_uuid	string
online	boolean
policy_ids	list
registration_date	date
mb_endpoint_last_scan	date
mb_endpoint_suspicious_activity_count	number
mb_endpoint_suspicious_activity_detected	boolean
active_managed_users	list
authenticated_root_volume_enabled	boolean
awaiting_configuration	boolean
bootstrap_token_allowed_for_authentication	string
bootstrap_token_required_for_kernel_extension_approval	boolean
bootstrap_token_required_for_software_update	boolean
carrier_settings_version	string
cellular_technology	string
current_carrier_network	string
current_mcc	string
current_mnc	string
data_roaming_enabled	boolean
days_since_last_cloud_backup	number
eas_device_identifier	string
ethernet_ma_cs	string
external_boot_level	string
firmware_password_change_pending	boolean
hardware_encryption_caps	string
hardware_model	string
has_unlock_token	boolean
iccid	string
imei	string
is_activation_lock_enabled	boolean
is_activation_lock_manageable	boolean
is_apple_silicon	boolean
is_cloud_backup_enabled	boolean
is_device_locator_service_enabled	boolean
is_do_not_disturb_in_effect	boolean
is_mdm_activation_lock_enabled	boolean
is_mdm_lost_mode_enabled	boolean
is_recovery_lock_enabled	boolean
is_roaming	boolean
is_shared_ipad	boolean
is_supervised	boolean
is_user_enrollment	boolean
languages	list
last_cloud_backup_date	date
maximum_resident_users	number
mdm_last_connected	date
meid	string
modem_firmware_version	string
passcode_compliant	boolean
passcode_compliant_with_profiles	boolean
passcode_lock_grace_period	number
passcode_lock_grace_period_enforced	number
passcode_present	boolean
personal_hotspot_enabled	boolean
phone_number	string
push_certificate_name	string
push_certificate_topic	string
secure_boot_level	string
sim_carrier_network	string
subscriber_carrier_network	string
subscriber_mcc	string
voice_roaming_enabled	boolean

Fact Types

Types are included in the request in all lowercase

Fact type	Allowed operations
string	= != > < >= <= contains
number	= != > < >= <= between
boolean	= !=
list	= != contains does not contain
date	= != > < >= <= between

Example Request

Getting devices and their facts with the Universal Device Search endpoint.

Get devices in one or more policies:

"filters": [
{
  "audit_field": "policy_id",
  "type": "list",
  "operation": "contains",
  "value": ["003f01fa-9bb3-421a-be29-409adf7a1xxx", "13d5bd9a-98ed-45e9-90a1-14027038fxxx"]
}
]