Retrieve agent configuration

GET

/v1/organizations/:organizationId/mdm/apple/enterprise/policies/:admPolicyId/agent-config

Retrieve agent configuration

Required Permission: mdm.apple.policy.get

Retrieves the MDM agent configuration settings derived from the policy for device deployment.

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

admPolicyId string

required

Apple device policy unique identifier used in URL path for retrieving or modifying specific policy configuration.

Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json

status boolean optional

data object optional

config object optional

Global MDM agent configuration settings defining polling intervals refresh actions and operational parameters across platforms.

checkInterval integer optional

MDM agent polling interval in seconds defining how frequently device checks for policy updates and pending commands.

≥ 0

allowRefreshAction boolean optional

Flag enabling manual refresh action in MDM agent allowing users to force immediate policy synchronization.

ios object optional

iOS and iPadOS specific MDM agent configuration settings controlling location tracking app monitoring and data collection behavior.

location object optional

iOS location tracking configuration defining polling frequency and data queue limits for geofencing and asset management.

active boolean optional

Flag enabling location tracking feature on iOS devices requiring user privacy consent and system location permissions.

refreshInterval integer optional

Location update polling interval in seconds controlling how frequently iOS agent reports device position coordinates.

≥ 0

queueLength integer optional

Maximum number of location updates queued locally on iOS device before forcing synchronization with MDM server.

≥ 0

applicationsTime object optional

iOS application usage time tracking configuration defining data collection frequency queue limits and report batch sizing.

active boolean optional

Flag enabling application usage time monitoring on iOS devices for productivity analysis and license optimization.

queueLength integer optional

Maximum number of app usage records queued locally on iOS device before forcing batch upload to MDM server.

≥ 0

reportLimit integer optional

Maximum number of app usage records included in single batch upload optimizing network efficiency and server load.

≥ 0

refreshInterval integer optional

App usage data collection interval in seconds controlling how frequently iOS agent samples application foreground time.

≥ 0

applicationsTransfer object optional

iOS application network data transfer monitoring configuration defining bandwidth tracking frequency and reporting parameters for security analysis.

active boolean optional

Flag enabling network data transfer monitoring per application on iOS devices for bandwidth analysis and threat detection.

queueLength integer optional

Maximum number of network transfer records queued locally on iOS device before forcing synchronization with server.

≥ 0

reportLimit integer optional

Maximum number of transfer records included in single batch upload balancing network efficiency with data granularity.

≥ 0

refreshInterval integer optional

Network transfer data collection interval in seconds controlling how frequently iOS agent samples application bandwidth usage.

≥ 0

macos object optional

macOS specific MDM agent configuration settings controlling location scripts device information and application monitoring behavior.

location object optional

macOS location tracking configuration defining polling frequency and data queue limits requiring user privacy consent.

active boolean optional

Flag enabling location tracking feature on macOS devices requiring explicit user consent and system location permissions.

refreshInterval integer optional

Location update polling interval in seconds controlling how frequently macOS agent reports device position coordinates.

≥ 0

queueLength integer optional

Maximum number of location updates queued locally on macOS device before forcing synchronization with MDM server.

≥ 0

applicationsTime object optional

macOS application usage time tracking configuration defining data collection frequency queue limits and report batch sizing.

active boolean optional

Flag enabling application usage time monitoring on macOS devices for productivity analysis and software license optimization.

queueLength integer optional

Maximum number of app usage records queued locally on macOS device before forcing batch upload to server.

≥ 0

reportLimit integer optional

Maximum number of app usage records included in single batch upload optimizing network efficiency and server processing.

≥ 0

refreshInterval integer optional

App usage data collection interval in seconds controlling how frequently macOS agent samples application foreground time.

≥ 0

applicationsTransfer object optional

macOS application network data transfer monitoring configuration tracking bandwidth usage per application for security and analysis.

active boolean optional

Flag enabling network data transfer monitoring per application on macOS devices for bandwidth and security analysis.

queueLength integer optional

Maximum number of network transfer records queued locally on macOS device before forcing synchronization with server.

≥ 0

reportLimit integer optional

Maximum number of transfer records included in single batch upload balancing network efficiency with data granularity.

≥ 0

refreshInterval integer optional

Network transfer data collection interval in seconds controlling how frequently macOS agent samples application bandwidth usage.

≥ 0

scripts object optional

macOS script execution configuration controlling compliance check frequency and automated task scheduling through MDM agent.

active boolean optional

Flag enabling script execution feature on macOS devices allowing automated compliance checks and configuration enforcement.

checkInterval integer optional

Script execution polling interval in seconds defining how frequently macOS agent checks for pending scripts to execute.

≥ 0

deviceInfo object optional

macOS device information collection configuration controlling battery usage Bluetooth discovery and system inventory reporting frequency.

batteryUsage object optional

macOS battery usage statistics collection configuration tracking power consumption per application for device health monitoring.

active boolean optional

Flag enabling battery usage statistics collection per application on macOS devices for power consumption analysis.

refreshInterval integer optional

Battery data collection interval in seconds controlling how frequently macOS agent samples application power consumption metrics.

≥ 0

queueLength integer optional

Maximum number of battery usage records queued locally on macOS device before forcing synchronization with server.

≥ 0

bluetooth object optional

macOS Bluetooth device discovery configuration tracking connected peripherals for inventory management and security compliance monitoring.

active boolean optional

Flag enabling Bluetooth device discovery and connection monitoring on macOS for peripheral inventory and security tracking.

refreshInterval integer optional

Bluetooth scan interval in seconds controlling how frequently macOS agent discovers connected and nearby Bluetooth devices.

≥ 0

systemInfo object optional

macOS comprehensive system information collection configuration gathering hardware specifications OS versions and software inventory with blacklist filtering.

active boolean optional

Flag enabling comprehensive system information collection including hardware OS versions and installed application inventory on macOS.

refreshInterval integer optional

System information collection interval in seconds controlling how frequently macOS agent gathers complete device inventory data.

≥ 0

blackList array [string] optional

List of bundle identifier prefixes to exclude from system information collection for privacy and performance optimization.

{
    "status": true,
    "data": {
        "config": {
            "checkInterval": 300,
            "allowRefreshAction": true
        },
        "ios": {
            "location": {
                "active": true,
                "refreshInterval": 600,
                "queueLength": 100
            }
        },
        "macos": {
            "location": {
                "active": true,
                "refreshInterval": 600,
                "queueLength": 100
            }
        }
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}