Addigy API v2 supersedes Addigy API v1.
Whenever possible API v2 should be used instead of API v1. Not all capabilities in API v1 are available in API v2 but are being added on regular basis. API v1 will be deprecated when API v2 fully supports everything provided by API v1.
To use API v2:
Note - To View, create keys, and delete keys the following permissions are necessary.
-
In Addigy go to Account > Integrations
- Select V2 and click on New API Token
- Choose the permissions you wish to allow for this API token. Use as few as possible 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.
- Visit the full API v2 documentation page and select "Authorize" and enter your API Token.
- Click the API call you wish to test and choose "Try it out". Be sure the token you created has the appropriate rights for the API calls you wish to use.
Syntax
General
The "Post" method is used for both creation of objects in Addigy and to provide a mechanism for more complex queries. The Post method allows providing sophisticated JSON to define specifically what data is needed.
Many of the Addigy API calls can return a large amount of data. When this the case, the date is paginated to be able to limit the amount of data returned in each call.
This call controls the pagination setting and will return 10 devices per call. On the each call to the API you are provided with the total number of pages of data. You may then iterate through them by specifying which page you would like on each API call. If you know there are 10 pages of data, you would make 10 API calls incrementing the page from 1 to 10.
"per_page": 10,
"page": 1,
Universal Search for Devices
A complete list of Device Facts than can be included in the API call.
The Devices API allows you to filter the devices returned by any Device Fact. Operations can include Greater / Less Than, Contains, Equals, and more.
This example includes devices that belong to Policies with the ID of either specified in the list.
"filters": [
{
"audit_field": "policy_id",
"type": "list",
"operation": "contains",
"value": ["003f01fa-9bb3-421a-be29-409adf7a1xxx", "13d5bd9a-98ed-45e9-90a1-14027038fxxx"]
}
]
This example returns devices that have an Addigy Agent version greater than 1.
"filters": [
{
"audit_field": "agent_version",
"type": "string",
"operation": ">",
"value": "1",
"range_value": ""
}
]
The Devices API requires the Device Fact values to be returned be specified. This example would return the Serial Number, Name of and Policy ID a device is associated with.
"desired_fact_identifiers": [
"serial_number",
"device_name",
"policy_id"
]
The Devices API allows you search through all device fact values for a specific value. This example searches all fact values for the value F17TWKMJxxx.
"search_any": "F17TWKMJxxx"
Get Policy Info
The POST policies query allows you to select 1 or more specific policies or to return all the policies from your Organization.
Return all policies - leave the request body empty except for the enclosing "{}"
{
}
Return a Single Policy
{
"policies": [
"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
]
}
Return Multiple Policies
{
"policies": [
"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
]
}
Device Fact List
battery_charging smart_failing watchman_monitoring_installed remote_desktop_enabled display_on xcode_installed remote_login_enabled kernel_panic has_wireless firewall_enabled gatekeeper_enabled filevault_enabled identity_installed identity_users java_vendor current_user os_platform device_model_name device_name splashtop_id splashtop_version addigy_splashtop_installed splashtop_installation_date mac_os_x_version hardware_model agent_version java_version timezone processor_type serial_number product_description localhost_name host_name wifi_mac_address ethernet_mac_address system_version local_ip total_disk_space_gb last_reboot_timestamp crashplan_days_since_last_backup total_memory_gb battery_failures uptime_days peer_count policy_execution_seconds battery_cycles free_disk_percentage processor_speed_ghz used_memory_gb battery_percentage battery_temperaturecelsius battery_temperature_fahrenheit free_disk_space_gb warranty_days_left battery_capacity_loss_percentage time_machine_days_since_last_backup tmp_size_mb lan_cache_size_bytes admin_users displays_serial_number os_version agentid client_ip audit_execution_time_seconds last_cloud_backup_date days_since_last_cloud_backup has_mdm_profile_approved third_party_daemons third_party_agents installed_profiles has_mdm languages locales awaiting_configuration build_version product_name cellular_technology imei meid modem_firmware_version is_supervised is_device_locator_service_enabled is_activation_lock_enabled is_do_not_disturb_in_effect eas_device_identifier is_cloud_backup_enabled system_integrity_protection_enabled active_managed_users is_mdm_lost_mode_enabled maximum_resident_users iccid bluetooth_mac software_update_device_id ethernet_ma_cs current_carrier_network sim_carrier_network subscriber_carrier_network carrier_settings_version phone_number voice_roaming_enabled data_roaming_enabled is_roaming personal_hotspot_enabled subscriber_mcc subscriber_mnc current_mcc current_mnc udid 32_bit_applications external_boot_level secure_boot_level is_user_enrollment passcode_compliant enrolled_via_dep is_activation_lock_manageable passcode_compliant_with_profiles passcode_lock_grace_period passcode_lock_grace_period_enforced passcode_present hardware_encryption_caps third_party_kernel_extensions firmware_password_allow_orams firmware_password_change_pending firmware_password_exists firewall_block_all_incoming_connections firewall_allowed_applications firewall_blocked_applications firewall_stealth_mode_enabled policy_id policy_ids is_compliant files_served bandwidth_saved_gb bandwidth_served_gb registration_date mac_uuid last_online online authenticated_root_volume_enabled bootstrap_token_allowed_for_authentication bootstrap_token_required_for_kernel_extension_approval bootstrap_token_required_for_software_update filevault_key_escrowed is_apple_silicon is_recovery_lock_enabled mb_oneview_installed identity_provider_name identity_user_display_name identity_username identity_employee_department identity_employee_type identity_employee_hire_date identity_job_title identity_email identity_mobile_phone identity_usage_location identity_office_location identity_password_last_set_date mb_endpoint_machine_id mb_endpoint_nebula_machine_id mb_endpoint_account_id mb_endpoint_agent_version microsoft_company_portal_version has_unlock_token mb_endpoint_suspicious_activity_detected mb_endpoint_suspicious_activity_count mb_endpoint_last_scan azure_ad_device_ids azure_ad_user_ids active_users mdm_last_connected is_mdm_client_stuck is_mdm_identity_certificate_installed is_mdm_softwareupdated_stuck privileged_mdm mdm_update_eligibility is_mdm_activation_lock_enabled is_sonoma_ready