Source
API documentation — SimpleMDM
Checked for SimpleMDM on 6 Nov 2026
- Page
- https://api.simplemdm.com/v1
- Checked
- 6 Nov 2026, 04:57 UTC
- How we may use it
- Public page, crawling permitted
Technical details
- type
- page
- http status
- 200
- content hash
- sha256:d354b4e93a7e37b5b8c78918dfeb043747ef8473d1c4f257aad1dd22ded925e4
- permission
- robots_ok
- screenshot
- Screenshot on file (internal exhibit, not published)
Cited by
Facts read from this source
-
API style Report an error
“The SimpleMDM API exists as a RESTful JSON implementation. It is designed to work over authenticated, HTTPS secured channels.”
-
Auth method Report an error
“The API uses HTTP Basic Authentication to receive your API key. It will look for your API key in the username field. The password field should be left blank.”
-
Https only Report an error
“SimpleMDM operates exclusively over HTTPS. Requests that are received over HTTP without encryption will fail.”
-
Pagination Report an error
“Many of the "list" API methods utilize cursor-based pagination using the limit and starting_after parameters. These methods also support ordering the result set by specifying the direction parameter.”
-
Pagination limit Report an error
“limit Optional. A limit on the number of objects to be returned, between 1 and 100. Defaults to 10.”
-
Errors format Report an error
“When the API encounters an error with your request, it will respond with an HTTP status code and a JSON-formatted body with additional details.”
-
Account endpoint Report an error
“Retrieve information about your account. Subscription information is only available for accounts on a manual billing plan.”
-
Apps management Report an error
“An app represents an app in your app catalog. You can manage your app catalog via the API and use assignment groups to install apps to your devices.”
-
App upload types Report an error
“You can use this method to add an App Store app, upload an enterprise iOS app, or upload macOS package to your app catalog.”
-
App deploy to option Report an error
“Deploy the app to associated devices immediately after the app has been uploaded and processed. Possible values are none, outdated or all.”
-
Munki pkginfo API Report an error
“Upload a new XML or PLIST file for a Munki App.”
-
Assignment groups Report an error
“An assignment group is an object that pairs apps with device groups and devices for the purpose of pushing apps and media to devices.”
-
Assignment group munki Report an error
“install_type Optional. The install type for munki assignment groups. Must be one of managed, self_serve, default_installs or managed_updates.”
-
Assignment group location tracking Report an error
“app_track_location Optional. If true, it tracks the location of IOS device when the SimpleMDM mobile app is installed. Defaults to true.”
-
Assignment group clone Report an error
“Clone an assignment group. The cloned assignment group will have the same apps, profiles, and devices as the original assignment group.”
-
Sync profiles rate limit Report an error
“This endpoint has a rate limit of 1 request every 30 seconds. When the limit is reached, it will return a status code of '429'.”
-
Custom attributes Report an error
“Define a new custom attribute for the account.”
-
Custom attribute bulk set Report an error
“Set multiple custom attribute values for a device.”
-
Custom attribute secrets Report an error
“When true, returns all custom attribute values including those marked as secret. Defaults to false.”
-
Custom configuration profiles Report an error
“mobileconfig Required. The mobileconfig file. Send as multipart/form-data.”
-
Profile declarative management Report an error
“declarative Optional. A boolean true or false. When enabled, this profile will be installed using Declarative Management on any device that has Declarative Management enabled.”
-
Profile scep auto renewal Report an error
“auto_renew_scep_based_certificates Optional. A boolean true or false. When enabled, SimpleMDM will automatically re-issue SCEP based certificates in the profile before they expire.”
-
Profile variables Report an error
“attribute_support Optional. A boolean true or false. When enabled, SimpleMDM will process variables in the uploaded profile. Defaults to false.”
-
Profile platform restrictions Report an error
“allowed_platforms Optional. An array of operating systems the profile is allowed to be installed on. Valid values: macos, ios, ipados, tvos. Defaults to all platforms.”
-
Custom declarations Report an error
“Create Argument Description name Required. A name for the profile. declaration_type Required. The type of declaration being defined. Configuration types, such as com.apple.configuration.passcode.settings, are activated on the device.”
-
Dep servers API Report an error
“Returns a list of Apple Business Manager server associations, which are used for the purposes of Automated Enrollment ( formerly Apple DEP or Device Enrollment Program).”
-
Dep sync frequency Report an error
“DEP server records are automatically synchronized with Apple every couple of hours. This provokes a manual sync.”
-
Devices API Report an error
“Returns a listing of all devices in the account. Supports pagination.”
-
Device search Report an error
“search Limit response to devices with matching name, UDID, serial number, IMEI, MAC address, or phone number.”
-
Device secrets Report an error
“When true and the API key has the Device Secrets permission, includes filevault_recovery_key, firmware_password, recovery_lock_password, activation_lock_bypass_codes, admin_passwords, device_lock_pins, and device_erase_pins.”
-
Webhooks Report an error
“Webhooks”
-
Additional modules Report an error
“Device Groups Enrollments Installed Apps Logs Lost Mode Managed App Configs Profiles Push Certificate Scripts Script Jobs”
Scores citing this record
- The Mac Fleet Administrator Configuration, apps & updates
- The Mac Fleet Administrator Device security & compliance
- The Mac Fleet Administrator Directory, API & administration
- The Field Operations Lead Device security & compliance
- The Field Operations Lead Directory, API & administration
- The Solo IT Administrator Configuration, apps & updates
- The Solo IT Administrator Device security & compliance
- The Solo IT Administrator Directory, API & administration
- The MSP Technician Configuration, apps & updates
- The MSP Technician Device security & compliance
- The MSP Technician Directory, API & administration
- The Information Security Officer Configuration, apps & updates
- The Information Security Officer Device security & compliance
- The Information Security Officer Directory, API & administration
- The Skeptic Configuration, apps & updates
- The Skeptic Device security & compliance
- The Skeptic Directory, API & administration