Integrations
API reference
Every Enlist API endpoint an API key can call, with the scope it needs, its parameters and what it returns.
Every endpoint below takes an API key in Authorization: Bearer enl_…. Paths are under your MSP's address and /api, so GET /devices is https://northwind.enlistit.app/api/devices. Read API: getting started first for keys, paging, errors and limits.
This page is made from Enlist's API description each time the docs are built, so it lists exactly what the server offers. Endpoints the console uses that keys can't reach aren't listed.
Endpoints by area #
- Clients and sites (29)
- Team (3)
- Activity log (7)
- Devices (17)
- Device groups and tags (8)
- Onboarding (1)
- Standard checks (1)
- Device health (2)
- Security score (2)
- Patching (8)
- Blueprints (6)
- Custom fields (2)
Clients and sites #
GET /clients #
The clients you can see, by name, each with how many of its active devices you can see.
Scope: clients:read
200 returns array of ClientView
POST /clients #
Scope: clients:write
Body (JSON)
| Field | Type |
|---|---|
name required | string |
201 returns NamedView
GET /clients/{clientId}/abm #
The client's Apple Business Manager link and its Macs: whether each has Enlist's enrollment profile, enrolled, and got the agent.
Scope: clients:read
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns AbmLinkView
POST /clients/{clientId}/abm #
Start linking the client's Apple Business Manager: Enlist makes the key whose public certificate goes into ABM. Does nothing when there is one.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns AbmLinkView
DELETE /clients/{clientId}/abm #
Forget the client's ABM link, after a fresh passkey check: its key, token and Macs. Macs already set up keep the agent; new ones no longer enroll.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
204 No Content
GET /clients/{clientId}/abm/public-key #
Enlist's public key certificate (PEM) to upload in ABM when adding Enlist's device management server.
Scope: clients:read
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns application/x-pem-file
PUT /clients/{clientId}/abm/site #
Pick the site the client's Macs enroll into (null: the whole client).
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
Body (JSON)
| Field | Type |
|---|---|
siteId required | string (uuid) (or null) |
200 returns AbmLinkView
POST /clients/{clientId}/abm/sync #
Read ABM's Macs now (also done every hour).
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns AbmLinkView
PUT /clients/{clientId}/abm/token #
Upload the server token ABM gave for Enlist's server (the .p7m file, base64), after a fresh passkey check. It is opened and checked with Apple before it is kept; Enlist then reads the Macs and gives them its enrollment profile.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
Body (JSON)
| Field | Type |
|---|---|
token required | string |
siteId | string (uuid) (or null) |
200 returns AbmLinkView
GET /clients/{clientId}/autopilot #
The client's Autopilot choices, whether its tenant is ready, and every Windows device's hash and registration.
Scope: clients:read
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns ClientAutopilotView
PUT /clients/{clientId}/autopilot #
Change the client's Autopilot choices: register every Windows device once its hash arrives, the group tag (at most 200 characters), and whether retiring a device removes it from Autopilot. Needs Manage clients.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
Body (JSON)
| Field | Type |
|---|---|
autoRegister required | boolean (or null) |
groupTag required | string (or null) |
removeOnRetire required | boolean (or null) |
200 returns ClientAutopilotView
GET /clients/{clientId}/autopilot/hashes.csv #
Every hash of the client's Windows devices in Microsoft's Autopilot CSV format, after a fresh passkey check, to import by hand in Intune. Needs Manage clients; audited.
Scope: clients:read
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns CSV (text/csv)
POST /clients/{clientId}/autopilot/register #
Register every Windows device of the client that has a hash and isn't registered. Needs Operate devices.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
202 returns RegisterAllView
GET /clients/{clientId}/custom-fields #
A client's custom fields with their values. Needs View clients for that client.
Scope: clients:read
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns array of CustomFieldValueView
PUT /clients/{clientId}/custom-fields #
Set or clear some of a client's custom fields. Needs Manage clients for that client.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
Body (JSON)
| Field | Type |
|---|---|
values required | map of string (or null) |
200 returns array of CustomFieldValueView
GET /clients/{clientId}/m365 #
The client's Microsoft 365 tenant, which app signs in to it, when it last worked, and which features its permissions cover. Needs Manage clients.
Scope: clients:read
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns M365ConnectionView
PUT /clients/{clientId}/m365 #
Connect the client's tenant or change it, after a fresh passkey check: its tenant ID and cloud, and the client's own app ID and secret (checked before saving) or none for the MSP's app.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
Body (JSON)
| Field | Type |
|---|---|
tenantId required | string (or null) |
cloud | string (or null) |
appClientId | string (or null) |
secret | string (or null) |
secretExpiresAt | string (date-time) (or null) |
200 returns M365ConnectionView
DELETE /clients/{clientId}/m365 #
Disconnect the client's tenant, after a fresh passkey check. Forgets its own app's secret. Nothing is changed in the tenant itself.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
204 No Content
POST /clients/{clientId}/m365/consent #
An admin consent link for the app the tenant uses, good for 30 minutes and once. An admin of the tenant (or the MSP's, through GDAP) opens it and accepts; Microsoft sends them back to the console.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns M365ConsentView
POST /clients/{clientId}/m365/test #
Sign in to the tenant now and read the app's permissions.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns M365ConnectionView
GET /clients/{clientId}/new-hires #
A client's new-hire requests, newest first, with each one's steps; whether the MSP can make them (Pro +) and whether the client's Microsoft 365 is connected. Needs View clients.
Scope: clients:read
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns NewHireList
POST /clients/{clientId}/new-hires #
Ask for a new hire: make their Microsoft 365 account with licenses, groups and a manager, and pre-register or assign their device. Pro + (402 needs_msp_plus). Needs Manage clients (and Operate devices for a device) and a fresh passkey check; audited.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
Body (JSON)
| Field | Type |
|---|---|
givenName required | string (or null) |
surname required | string (or null) |
displayName required | string (or null) |
createAccount required | boolean |
userPrincipalName required | string (or null) |
usageLocation | string (or null) |
jobTitle | string (or null) |
department | string (or null) |
startDate | string (date) (or null) |
managerUpn | string (or null) |
licenses | array of NewHireNamed (or null) |
groups | array of NewHireNamed (or null) |
deviceMode | string |
serialNumber | string (or null) |
deviceId | string (uuid) (or null) |
siteId | string (uuid) (or null) |
blueprintId | string (uuid) (or null) |
shipTo | string (or null) |
carrier | string (or null) |
trackingNumber | string (or null) |
note | string (or null) |
201 returns NewHireView
GET /clients/{clientId}/new-hires/options #
What the new-hire form offers from the client's Microsoft 365: its domains, licenses (with how many are free) and groups. Pro +. Needs Manage clients.
Scope: clients:read
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns DirectoryOptions
GET /clients/{clientId}/self-service #
A client's self-service apps: whether it's on, its approvers, the apps offered and the latest 200 requests. Needs View clients on the client.
Scope: clients:read
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns SelfServiceView
GET /clients/{clientId}/sites #
Scope: clients:read
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns array of NamedView
POST /clients/{clientId}/sites #
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
Body (JSON)
| Field | Type |
|---|---|
name required | string |
201 returns NamedView
GET /clients/{clientId}/status-links #
A client's status page links (never their secrets), and whether the MSP can make new ones (Pro +). Needs View clients on the client.
Scope: clients:read
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
200 returns StatusLinkList
POST /clients/{clientId}/status-links #
Make a no-login link to the client's status page, in the MSP's branding. Pro + only (402 needs_msp_plus). The URL is returned only this once. Needs Manage clients on the client and a fresh passkey check; audited.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
Body (JSON)
| Field | Type |
|---|---|
label required | string (or null) |
expiresInDays required | integer (int32) (or null) |
201 returns StatusLinkCreated
DELETE /clients/{clientId}/status-links/{linkId} #
Revoke a status page link: it stops working at once. Needs Manage clients on the client; audited.
Scope: clients:write
| Parameter | In | Type |
|---|---|---|
clientId required | path | string (uuid) |
linkId required | path | string (uuid) |
200 returns StatusLinkView
Team #
GET /team #
Scope: team:read
200 returns array of TeamEndpointsMemberView
GET /team/access-review #
Access review: every user with their roles and where they apply, status, passkeys and SSO, last sign-in, plus the API keys. Needs View team and View activity.
Scope: team:read and audit:read
200 returns Report
GET /team/access-review.csv #
The access review as CSV, one line per user and then one per API key. Each download is audited.
Scope: team:read and audit:read
200 returns CSV (text/csv)
Activity log #
GET /audit #
Activity, newest first. Page with before = the last seq you got; limit up to 500.
Scope: audit:read
| Parameter | In | Type |
|---|---|---|
before | query | integer (int64) |
limit | query | integer (int32) |
200 returns array of EventView
GET /audit/anchor-key #
The public key anchors are signed with (ES256 over the anchor body's UTF-8 bytes), for checking copies outside Enlist.
Scope: audit:read
200 returns AnchorKeyView
GET /audit/anchors #
The activity log's signed anchors, oldest first, each checked against the log and against the anchor before it. Needs View activity.
Scope: audit:read
200 returns AnchorsView
GET /audit/archives #
Archives of activity older than the MSP's retention (View activity).
Scope: audit:read
200 returns ArchivesView
GET /audit/archives/{n} #
Download one archive: the export's CSV rows, gzipped. The download is audited.
Scope: audit:read
| Parameter | In | Type |
|---|---|---|
n required | path | integer (int32) |
200 returns application/gzip
GET /audit/export #
The activity log as CSV (format=csv, the default) or JSON Lines (format=json), oldest first, optionally from and to a UTC date (inclusive). Rows carry prev_hash and hash so the chain can be re-checked outside Enlist. Needs View activity; each download is audited.
Scope: audit:read
| Parameter | In | Type |
|---|---|---|
format | query | string |
from | query | string (date) |
to | query | string (date) |
200 returns CSV (text/csv)
GET /audit/verify #
Re-checks the hash chain; brokenAt is the first event that doesn't match.
Scope: audit:read
200 returns AuditLogVerifyView
Devices #
GET /devices #
Devices in the clients you can see, a page at a time (limit, after), active first and by hostname; search matches hostname, serial or assigned user; state is active, retired or all; tag, group or client shows only those devices (with client, counts cover that client); field (a custom field name) with fieldValue shows devices whose field is that value, or has any value without fieldValue.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
limit | query | integer (int32) |
after | query | string |
search | query | string |
state | query | string |
tag | query | string |
group | query | string (uuid) |
client | query | string (uuid) |
field | query | string |
fieldValue | query | string |
200 returns DevicePage
POST /devices/tags #
Add and remove tags on up to 200 devices at once.
Scope: devices:organize
Body (JSON)
| Field | Type |
|---|---|
deviceIds required | array of string (uuid) (or null) |
add required | array of string (or null) |
remove required | array of string (or null) |
200 returns BulkTagsView
GET /devices/{deviceId} #
One device with its latest inventory.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns DeviceDetailView
GET /devices/{deviceId}/add-ons #
The add-ons whose tag a device carries, and whether each has applied.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns array of DeviceAddOnView
GET /devices/{deviceId}/autopilot #
A Windows device's Autopilot hardware hash (when the agent last read it, never the hash) and its registration in the client's Autopilot service.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns DeviceAutopilotView
GET /devices/{deviceId}/blueprint #
The published blueprint a device onboards with: its site's, else its client's.
Scope: devices:read and blueprints:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns DeviceBlueprintView
GET /devices/{deviceId}/commands #
Recent commands for a device.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns array of CommandView
GET /devices/{deviceId}/custom-fields #
A device's custom fields with their values, and its client's. Needs View devices.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns DeviceValuesView
GET /devices/{deviceId}/onboarding #
A device's latest onboarding session and its steps.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns SessionView
GET /devices/{deviceId}/os-patches #
The OS patches the device's latest scan says it needs, and the ones it has installed.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns DeviceOsPatchesView
PUT /devices/{deviceId}/patch-ring #
Put a device in the test, pilot or everyone ring, or send ring: null to let its id pick.
Scope: devices:organize
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
Body (JSON)
| Field | Type |
|---|---|
ring required | string (or null) |
200 returns RingView
GET /devices/{deviceId}/remote-control #
The MSP's remote control tools with this device's ID in each. Needs Operate devices.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns array of DeviceRemoteToolView
GET /devices/{deviceId}/security-score #
One device's security score and every check, with what it found.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns DeviceSecurityView
GET /devices/{deviceId}/standard-check #
A device's last standard check result and its latest check with its steps.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns DeviceStandardView
PUT /devices/{deviceId}/tags #
Replace a device's tags (at most 20; letters, digits, spaces, dots, dashes, underscores).
Scope: devices:organize
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
Body (JSON)
| Field | Type |
|---|---|
tags required | array of string (or null) |
200 returns array of string
GET /devices/{deviceId}/wake #
Whether a device that is offline can be woken with Wake-on-LAN, its network adapters, and which online devices would send the packets.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns WakeView
GET /devices/{deviceId}/warranty #
A device's warranty and refresh date. Needs View devices on it. Available false when the MSP is not on Pro +.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
deviceId required | path | string (uuid) |
200 returns DeviceWarrantyResponse
Device groups and tags #
GET /device-groups #
Device groups you can see, each with how many of its devices you can see.
Scope: devices:read
200 returns array of GroupView
POST /device-groups #
Make a group: a name, optionally one client, and rules (all or any) that pick its devices.
Scope: devices:organize
Body (JSON)
| Field | Type |
|---|---|
name required | string (or null) |
description required | string (or null) |
clientId required | string (uuid) (or null) |
match required | "all" | "any" (or null) |
rules required | array of GroupRule (or null) |
201 returns GroupView
POST /device-groups/preview #
Which devices these rules would pick, before saving them.
Scope: devices:read
Body (JSON)
| Field | Type |
|---|---|
clientId required | string (uuid) (or null) |
match required | "all" | "any" (or null) |
rules required | array of GroupRule (or null) |
200 returns MembersView
GET /device-groups/{groupId} #
One group.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
groupId required | path | string (uuid) |
200 returns GroupView
PUT /device-groups/{groupId} #
Change a group's name, description, client or rules.
Scope: devices:organize
| Parameter | In | Type |
|---|---|---|
groupId required | path | string (uuid) |
Body (JSON)
| Field | Type |
|---|---|
name required | string (or null) |
description required | string (or null) |
clientId required | string (uuid) (or null) |
match required | "all" | "any" (or null) |
rules required | array of GroupRule (or null) |
200 returns GroupView
DELETE /device-groups/{groupId} #
Delete a group. Its devices don't change.
Scope: devices:organize
| Parameter | In | Type |
|---|---|---|
groupId required | path | string (uuid) |
204 No Content
GET /device-groups/{groupId}/devices #
The group's devices right now (those you can see).
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
groupId required | path | string (uuid) |
limit | query | integer (int32) |
200 returns MembersView
GET /device-tags #
Every tag on a device you can see, with how many active devices carry it.
Scope: devices:read
200 returns array of TagCount
Onboarding #
GET /onboarding-sessions/{sessionId} #
An onboarding session and its steps.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
sessionId required | path | string (uuid) |
200 returns SessionView
Standard checks #
GET /standard-checks/summary #
Each client's devices by their last standard check: in standard, fixed, failed and not checked yet.
Scope: devices:read
200 returns array of StandardClientSummary
Device health #
GET /health-alerts #
Device health alerts, newest first: open ones (state=open, the default), resolved ones (state=resolved) or all. Filter by clientId or deviceId; at most 500.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
state | query | string |
clientId | query | string (uuid) |
deviceId | query | string (uuid) |
200 returns array of HealthAlertView
GET /health-alerts/summary #
Each client's devices and their open health alerts by kind.
Scope: devices:read
200 returns array of HealthClientSummary
Security score #
GET /security-scores #
The security score (0 to 100) of the caller's devices, each client's (?clientId= for one) and each device's: disk encryption, antivirus, firewall, OS patches, local admin accounts, Secure Boot and TPM, and checking in. Lists the 100 lowest-scoring devices, or every device with ?devices=all.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
devices | query | string |
200 returns SecurityReport
503 Service Unavailable
GET /security-scores.csv #
The security score as CSV, one line per device with each check's result, to send to the client (X-Enlist-Truncated: true when cut at 10,000 devices).
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
200 returns CSV (text/csv)
503 Service Unavailable
Patching #
GET /patching/exceptions #
Every patch and app update kept off somewhere on purpose (?clientId= for one client): exceptions with their reason, owner and end date, declines and blocks for every client, and app version pins.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
200 returns PatchExceptionsReport
503 Service Unavailable
GET /patching/exceptions.csv #
The exceptions report as CSV, for auditors.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
200 returns CSV (text/csv)
503 Service Unavailable
GET /patching/os #
OS patches devices need (?clientId=), riskiest first, with what the client's policy does with each.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
200 returns array of OsPatchView
GET /patching/reports/cves #
Known vulnerabilities still open on the caller's devices (?clientId=), and on which devices.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
200 returns CveReportList
503 Service Unavailable
GET /patching/reports/cves.csv #
The open vulnerabilities as CSV (X-Enlist-Truncated: true when built from the first 10,000 devices only).
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
200 returns CSV (text/csv)
503 Service Unavailable
GET /patching/reports/os #
How patched each client's devices are (?clientId= for one client): missing, waiting for approval, failed, deadlines. ?devices=failed lists only devices that failed a patch (at most 100); the default lists every device.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
devices | query | string |
200 returns OsPatchReport
503 Service Unavailable
GET /patching/reports/os.csv #
The same report, one line per device, as CSV to send to the client (X-Enlist-Truncated: true when cut at 10,000 devices).
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
200 returns CSV (text/csv)
503 Service Unavailable
GET /patching/rings #
Each device's patch ring (?clientId= for one client).
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
200 returns array of RingView
Blueprints #
GET /blueprint-versions/{versionId} #
One version: what was published, resolved, and its signed plans.
Scope: blueprints:read
| Parameter | In | Type |
|---|---|---|
versionId required | path | string (uuid) |
200 returns VersionDetailView
GET /blueprints #
Templates and client and site blueprints (?clientId= for one client's).
Scope: blueprints:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
archived | query | boolean |
200 returns array of BlueprintView
GET /blueprints/{blueprintId} #
A blueprint with its draft.
Scope: blueprints:read
| Parameter | In | Type |
|---|---|---|
blueprintId required | path | string (uuid) |
200 returns BlueprintDetailView
GET /blueprints/{blueprintId}/compare #
What changed between two versions, or a version and the saved draft (?from=<version id>&to=<version id, draft, or restore:<version id> for the draft a restore would make>): steps and checks added, removed, changed field by field, or moved.
Scope: blueprints:read
| Parameter | In | Type |
|---|---|---|
blueprintId required | path | string (uuid) |
from | query | string |
to | query | string |
200 returns CompareView
GET /blueprints/{blueprintId}/preview #
The draft resolved on its base: every item with where it comes from, and the steps per platform in run order.
Scope: blueprints:read
| Parameter | In | Type |
|---|---|---|
blueprintId required | path | string (uuid) |
200 returns PreviewView
GET /blueprints/{blueprintId}/versions #
Published and pending versions, newest first.
Scope: blueprints:read
| Parameter | In | Type |
|---|---|---|
blueprintId required | path | string (uuid) |
200 returns array of BlueprintEndpointsVersionView
Custom fields #
GET /custom-fields #
The MSP's custom fields (entity=device or client for one kind). Needs View devices or View clients somewhere.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
entity | query | string |
200 returns array of CustomFieldView
GET /custom-fields/report.csv #
Every active device you can see with its device fields and its client's fields, as CSV. Needs View devices.
Scope: devices:read
| Parameter | In | Type |
|---|---|---|
clientId | query | string (uuid) |
200 returns CSV (text/csv)
Schemas #
The shapes the endpoints above send and return. Fields can be added at any time, so ignore ones you don't know.
AbmCommandView #
| Field | Type |
|---|---|
step required | string |
state required | string |
error required | string (or null) |
doneAt required | string (date-time) (or null) |
AbmLinkView #
| Field | Type |
|---|---|
configured required | boolean |
connected required | boolean |
siteId required | string (uuid) (or null) |
orgName required | string (or null) |
serverName required | string (or null) |
tokenExpiresAt required | string (date-time) (or null) |
syncedAt required | string (date-time) (or null) |
syncing required | boolean |
lastError required | string (or null) |
lastErrorAt required | string (date-time) (or null) |
connectedAt required | string (date-time) (or null) |
pushReady required | boolean |
macs required | array of AbmMacView |
AbmMacView #
| Field | Type |
|---|---|
serial required | string |
model required | string (or null) |
description required | string (or null) |
profileStatus required | string (or null) |
hasEnlistProfile required | boolean |
assignError required | string (or null) |
mdmState required | string (or null) |
enrolledAt required | string (date-time) (or null) |
configuredAt required | string (date-time) (or null) |
lastError required | string (or null) |
deviceId required | string (uuid) (or null) |
stage required | string |
steps required | array of AbmCommandView |
AccessReviewKeyView #
| Field | Type |
|---|---|
id required | string (uuid) |
name required | string |
scopes required | array of string |
createdBy required | string |
createdAt required | string (date-time) |
expiresAt required | string (date-time) |
lastUsedAt required | string (date-time) (or null) |
status required | string |
AnchorKeyView #
| Field | Type |
|---|---|
keyId required | string |
algorithm required | string |
publicKey required | string |
AnchorView #
| Field | Type |
|---|---|
n required | integer (int32) |
throughSeq required | integer (int64) |
headHash required | string |
anchoredAt required | string (date-time) |
reason required | string |
prevAnchorSha256 required | string (or null) |
body required | string |
keyId required | string |
signature required | string |
matchesLog required | boolean |
linksToPrevious required | boolean |
archived required | boolean |
AnchorsView #
| Field | Type |
|---|---|
available required | boolean |
keyId required | string |
exportedOutside required | boolean |
anchors required | array of AnchorView |
ArchiveView #
| Field | Type |
|---|---|
n required | integer (int32) |
fromSeq required | integer (int64) |
throughSeq required | integer (int64) |
entries required | integer (int64) |
sha256 required | string |
size required | integer (int64) |
archivedAt required | string (date-time) |
ArchivesView #
| Field | Type |
|---|---|
available required | boolean |
prunedThroughSeq required | integer (int64) (or null) |
archives required | array of ArchiveView |
AuditLogVerifyView #
| Field | Type |
|---|---|
intact required | boolean |
events required | integer (int64) |
brokenAt required | integer (int64) (or null) |
AutopilotDeviceView #
| Field | Type |
|---|---|
deviceId required | string (uuid) |
hostname required | string (or null) |
serial required | string |
hashCaptured required | boolean |
capturedAt required | string (date-time) (or null) |
captureError required | string (or null) |
captureErrorAt required | string (date-time) (or null) |
state required | string |
groupTag required | string (or null) |
error required | string (or null) |
requestedAt required | string (date-time) (or null) |
registeredAt required | string (date-time) (or null) |
AutopilotSettingsView #
| Field | Type |
|---|---|
autoRegister required | boolean |
groupTag required | string (or null) |
removeOnRetire required | boolean |
AutopilotTenantView #
| Field | Type |
|---|---|
connected required | boolean |
ready required | boolean |
tenantName required | string (or null) |
problem required | string (or null) |
BlueprintDetailView #
| Field | Type |
|---|---|
blueprint required | BlueprintView |
draft required | BlueprintDocument |
editing | object (or null) or EditSessionView |
BlueprintDocument #
| Field | Type |
|---|---|
items | array of BlueprintItem (or null) |
remove | array of string (or null) |
BlueprintEndpointsCheckView #
| Field | Type |
|---|---|
ordinal required | integer (int32) |
itemKey required | string |
kind required | "windows_update" | "check" |
name required | string |
rounds required | integer (int32) |
BlueprintEndpointsStepView #
| Field | Type |
|---|---|
ordinal required | integer (int32) |
itemKey required | string |
kind required | string |
name required | string |
dependsOn required | array of integer (int32) |
timeoutSeconds required | integer (int32) |
stepSha256 required | string (or null) |
BlueprintEndpointsVersionView #
| Field | Type |
|---|---|
id required | string (uuid) |
blueprintId required | string (uuid) |
version required | integer (int32) |
state required | "pending" | "published" | "discarded" |
createdAt required | string (date-time) |
publishedAt required | string (date-time) (or null) |
baseVersionId required | string (uuid) (or null) |
expiresAt required | string (date-time) (or null) |
digestSha256 required | string |
approvedBy required | array of string (uuid) |
approvalsRequired required | integer (int32) (or null) |
plans required | array of PlanView |
BlueprintItem #
| Field | Type |
|---|---|
key required | string |
type required | "package" | "script" | "rename" | "settings" | "admin_account" | "disk_encryption" | "domain_join" | "reboot" | "windows_update" | "check" | "cleanup" | "office" | "notify_user" | "microsoft_sign_in" | "regional" |
name | string (or null) |
locked | boolean (or null) |
after | array of string (or null) |
timeoutSeconds | integer (int32) (or null) |
packageVersionId | string (uuid) (or null) |
category | string (or null) |
language | string (or null) |
script | string (or null) |
runAs | string (or null) |
parameters | array of ScriptParameter (or null) |
message | string (or null) |
nameTemplate | string (or null) |
settings | array of BlueprintSetting (or null) |
username | string (or null) |
fullName | string (or null) |
hidden | boolean (or null) |
passwordLength | integer (int32) (or null) |
disableBuiltinAdministrator | boolean (or null) |
encryptionMethod | string (or null) |
usedSpaceOnly | boolean (or null) |
domain | string (or null) |
joinMethod | string (or null) |
ou | string (or null) |
rounds | integer (int32) (or null) |
check | string (or null) |
service | string (or null) |
removeOffice | boolean (or null) |
removeApps | array of string (or null) |
officeProduct | string (or null) |
appleAccount | string (or null) |
continueOnFailure | boolean (or null) |
title | string (or null) |
buttons | string (or null) |
defaultAnswer | string (or null) |
answerMinutes | integer (int32) (or null) |
onlyIf | object (or null) or OnlyIf |
installKeys | array of string (or null) |
customFields | array of string (or null) |
microsoftSignIn | object (or null) or MicrosoftSignIn |
locale | string (or null) |
keyboardLayout | string (or null) |
homeLocation | integer (int32) (or null) |
timeZone | string (or null) |
BlueprintSetting #
| Field | Type |
|---|---|
registry | object (or null) or RegistrySetting |
service | object (or null) or ServiceSetting |
macDefault | object (or null) or MacDefaultSetting |
BlueprintView #
| Field | Type |
|---|---|
id required | string (uuid) |
name required | string |
description required | string |
clientId required | string (uuid) (or null) |
siteId required | string (uuid) (or null) |
baseBlueprintId required | string (uuid) (or null) |
publishedVersion required | integer (int32) (or null) |
publishedAt required | string (date-time) (or null) |
hasUnpublishedChanges required | boolean |
draftUpdatedAt required | string (date-time) |
createdAt required | string (date-time) |
archivedAt required | string (date-time) (or null) |
addOnTag | string (or null) |
publishedPlatforms | array of string (or null) |
BulkTagsView #
| Field | Type |
|---|---|
changed required | integer (int32) |
ClientAutopilotView #
| Field | Type |
|---|---|
settings required | AutopilotSettingsView |
tenant required | AutopilotTenantView |
windowsDevices required | integer (int32) |
devices required | array of AutopilotDeviceView |
ClientPatchReport #
| Field | Type |
|---|---|
clientId required | string (uuid) (or null) |
clientName required | string |
devices required | integer (int32) |
fullyPatched required | integer (int32) |
percent required | integer (int32) (or null) |
notScanned required | integer (int32) |
missingPatches required | integer (int32) |
pendingApproval required | integer (int32) |
failedDevices required | integer (int32) |
waitingDevices required | integer (int32) |
nextDeadline required | string (date-time) (or null) |
overdueDevices | integer (int32) |
ClientSecurityLine #
| Field | Type |
|---|---|
clientId required | string (uuid) (or null) |
clientName required | string |
devices required | integer (int32) |
unscored required | integer (int32) |
score required | integer (int32) (or null) |
grade required | "good" | "fair" | "at_risk" (or null) |
good required | integer (int32) |
fair required | integer (int32) |
atRisk required | integer (int32) |
checks required | array of SecurityCheckCount |
ClientView #
| Field | Type |
|---|---|
id required | string (uuid) |
name required | string |
activeDevices required | integer (int32) (or null) |
CommandView #
| Field | Type |
|---|---|
id required | string (uuid) |
deviceId required | string (uuid) |
jobId required | string (uuid) (or null) |
kind required | string |
state required | string |
createdAt required | string (date-time) |
expiresAt required | string (date-time) |
sentAt required | string (date-time) (or null) |
startedAt required | string (date-time) (or null) |
finishedAt required | string (date-time) (or null) |
exitCode required | integer (int32) (or null) |
rebootRequired required | boolean |
detail required | string (or null) |
CompareSide #
| Field | Type |
|---|---|
versionId required | string (uuid) (or null) |
version required | integer (int32) (or null) |
state required | "draft" | "restored" | "pending" | "published" | "discarded" |
at required | string (date-time) (or null) |
baseName required | string (or null) |
baseVersion required | integer (int32) (or null) |
CompareView #
| Field | Type |
|---|---|
from required | CompareSide |
to required | CompareSide |
changes required | array of ItemChange |
unchanged required | integer (int32) |
CustomFieldValueView #
| Field | Type |
|---|---|
fieldId required | string (uuid) |
name required | string |
label required | string |
type required | "text" | "number" | "yes_no" | "date" | "choice" |
choices required | array of string |
value required | string (or null) |
setBy required | "person" | "script" (or null) |
updatedAt required | string (date-time) (or null) |
CustomFieldView #
| Field | Type |
|---|---|
id required | string (uuid) |
entity required | "device" | "client" |
name required | string |
label required | string |
description required | string |
type required | "text" | "number" | "yes_no" | "date" | "choice" |
choices required | array of string |
defaultValue required | string (or null) |
scriptsCanSet required | boolean |
variable required | string |
updatedAt required | string (date-time) |
CveReport #
| Field | Type |
|---|---|
cve required | string |
severity required | string |
devices required | integer (int32) |
patches required | array of string |
hostnames required | array of string |
declined required | boolean |
exploited required | boolean |
ransomware required | boolean |
exploitedSince required | string (date) (or null) |
fixBy required | string (date) (or null) |
CveReportList #
| Field | Type |
|---|---|
cves required | array of CveReport |
truncated required | boolean |
exploitedListAt | string (date-time) (or null) |
DeviceAddOnView #
| Field | Type |
|---|---|
blueprintId required | string (uuid) |
name required | string |
tag required | string |
version required | integer (int32) (or null) |
state required | "applied" | "failed" | "running" | "waiting" | "no_plan" |
lastRunAt required | string (date-time) (or null) |
lastSessionId required | string (uuid) (or null) |
DeviceAutopilotView #
| Field | Type |
|---|---|
device required | AutopilotDeviceView |
tenant required | AutopilotTenantView |
DeviceBlueprintView #
| Field | Type |
|---|---|
blueprintId required | string (uuid) |
name required | string |
version required | BlueprintEndpointsVersionView |
DeviceDetailView #
| Field | Type |
|---|---|
device required | DeviceView |
inventoryRevision required | integer (int64) |
inventoryAt required | string (date-time) (or null) |
inventory required | object (or null) or JsonElement |
DeviceEndpointsDeviceCounts #
| Field | Type |
|---|---|
active required | integer (int32) |
online required | integer (int32) |
DeviceGroupsMemberView #
| Field | Type |
|---|---|
id required | string (uuid) |
hostname required | string |
platform required | "windows" | "macos" |
clientId required | string (uuid) (or null) |
serialNumber required | string |
model required | string |
DeviceOsPatchesView #
| Field | Type |
|---|---|
deviceId required | string (uuid) |
hostname required | string |
scannedAt required | string (date-time) (or null) |
scanning required | boolean |
available required | array of DevicePatchView |
installed required | array of InstalledPatchView |
DevicePage #
| Field | Type |
|---|---|
devices required | array of DeviceView |
next required | string (or null) |
counts required | object (or null) or DeviceEndpointsDeviceCounts |
DevicePatchReport #
| Field | Type |
|---|---|
deviceId required | string (uuid) |
hostname required | string |
clientId required | string (uuid) (or null) |
clientName required | string |
platform required | string |
ring required | string |
state required | string |
scannedAt required | string (date-time) (or null) |
missing required | integer (int32) |
pendingApproval required | integer (int32) |
failed required | integer (int32) |
openCves required | integer (int32) |
deadline required | string (date-time) (or null) |
overdue | integer (int32) |
nextDue | string (date-time) (or null) |
DevicePatchView #
| Field | Type |
|---|---|
patch required | OsPatchView |
fromVersion required | string |
toVersion required | string |
size required | integer (int64) |
install required | string (or null) |
installSentAt required | string (date-time) (or null) |
DeviceRemoteToolView #
| Field | Type |
|---|---|
toolId required | string (uuid) |
name required | string |
idLabel required | string |
needsDeviceId required | boolean |
opensInBrowser required | boolean |
remoteId required | string (or null) |
remoteIdUpdatedAt required | string (date-time) (or null) |
remoteIdUpdatedBy required | string (or null) |
remoteIdSource required | "typed" | "agent" (or null) |
agentRemoteId required | string (or null) |
readsIdFrom required | string (or null) |
DeviceSecurityLine #
| Field | Type |
|---|---|
deviceId required | string (uuid) |
hostname required | string |
platform required | "windows" | "macos" |
clientId required | string (uuid) (or null) |
clientName required | string |
score required | integer (int32) (or null) |
grade required | "good" | "fair" | "at_risk" (or null) |
failing required | array of string |
partial required | array of string |
DeviceSecurityView #
| Field | Type |
|---|---|
deviceId required | string (uuid) |
hostname required | string |
platform required | "windows" | "macos" |
clientId required | string (uuid) (or null) |
clientName required | string |
score required | integer (int32) (or null) |
grade required | "good" | "fair" | "at_risk" (or null) |
checks required | array of SecurityCheck |
generatedAt required | string (date-time) |
fixes required | array of SecurityFixOffer |
guides required | array of SecurityGuide |
DeviceStandardView #
| Field | Type |
|---|---|
deviceId required | string (uuid) |
state required | "in_standard" | "fixed" | "failed" (or null) |
checkedAt required | string (date-time) (or null) |
enabled required | boolean |
latest required | object (or null) or SessionView |
DeviceValuesView #
| Field | Type |
|---|---|
device required | array of CustomFieldValueView |
client required | array of CustomFieldValueView |
clientId required | string (uuid) (or null) |
DeviceView #
| Field | Type |
|---|---|
id required | string (uuid) |
hostname required | string |
platform required | "windows" | "macos" |
clientId required | string (uuid) (or null) |
siteId required | string (uuid) (or null) |
serialNumber required | string |
manufacturer required | string |
model required | string |
osVersion required | string |
agentVersion required | string |
isVirtualMachine required | boolean |
enrolledAt required | string (date-time) |
lastSeenAt required | string (date-time) (or null) |
online required | boolean |
retiredAt required | string (date-time) (or null) |
certificateNotAfter required | string (date-time) |
renewalPending required | boolean |
renewRequestedAt required | string (date-time) (or null) |
tags required | array of string |
standardState required | "in_standard" | "fixed" | "failed" (or null) |
standardCheckedAt required | string (date-time) (or null) |
blueprintId | string (uuid) (or null) |
assignedUser | string (or null) |
DeviceWarrantyResponse #
| Field | Type |
|---|---|
available required | boolean |
warranty required | object (or null) or WarrantyView |
DirectoryGroup #
| Field | Type |
|---|---|
id required | string (uuid) |
name required | string |
kind required | string |
DirectoryLicense #
| Field | Type |
|---|---|
skuId required | string (uuid) |
name required | string |
available required | integer (int32) |
DirectoryOptions #
| Field | Type |
|---|---|
domains required | array of string |
licenses required | array of DirectoryLicense |
groups required | array of DirectoryGroup |
groupsTruncated required | boolean |
DirectoryStatus #
| Field | Type |
|---|---|
connected required | boolean |
missing required | array of string |
message required | string (or null) |
EditSessionView #
| Field | Type |
|---|---|
expiresAt required | string (date-time) |
EventView #
| Field | Type |
|---|---|
seq required | integer (int64) |
occurredAt required | string (date-time) |
actorKind required | string |
actorUserId required | string (uuid) (or null) |
action required | string |
targetType required | string (or null) |
targetId required | string (uuid) (or null) |
clientId required | string (uuid) (or null) |
ip required | string (or null) |
details required | JsonElement |
hash required | string |
FieldChange #
| Field | Type |
|---|---|
field required | string |
label required | string |
before required | string (or null) |
after required | string (or null) |
GrantView #
| Field | Type |
|---|---|
id required | string (uuid) |
role required | string |
clientId required | string (uuid) (or null) |
siteId required | string (uuid) (or null) |
GroupRule #
| Field | Type |
|---|---|
field required | "hostname" | "serial_number" | "manufacturer" | "model" | "os_version" | "platform" | "virtual_machine" | "patch_ring" | "client" | "site" | "tag" | "enrolled_days" | "last_seen_days" | "custom_field" (or null) |
op required | "contains" | "not_contains" | "starts_with" | "is" | "in" | "not_in" | "has" | "lacks" | "within" | "older_than" | "above" | "below" (or null) |
value | string (or null) |
ids | array of string (uuid) (or null) |
name | string (or null) |
GroupView #
| Field | Type |
|---|---|
id required | string (uuid) |
name required | string |
description required | string |
clientId required | string (uuid) (or null) |
match required | "all" | "any" |
rules required | array of GroupRule |
deviceCount required | integer (int32) |
updatedAt required | string (date-time) |
HealthAlertView #
| Field | Type |
|---|---|
id required | string (uuid) |
deviceId required | string (uuid) |
hostname required | string |
platform required | "windows" | "macos" |
clientId required | string (uuid) (or null) |
clientName required | string (or null) |
kind required | "offline" | "encryption_off" | "antivirus_off" | "disk_low" |
title required | string |
state required | "pending" | "open" | "resolved" |
detail required | string |
firstSeenAt required | string (date-time) |
openedAt required | string (date-time) (or null) |
lastCheckedAt required | string (date-time) |
resolvedAt required | string (date-time) (or null) |
resolvedReason required | "fixed" | "retired" | "turned_off" (or null) |
acknowledgedAt required | string (date-time) (or null) |
acknowledgedBy required | string (or null) |
ticketProvider required | "halo" | "psa" (or null) |
ticketId required | integer (int64) (or null) |
ticketError required | string (or null) |
HealthClientSummary #
| Field | Type |
|---|---|
clientId required | string (uuid) (or null) |
clientName required | string (or null) |
devices required | integer (int32) |
healthy required | integer (int32) |
offline required | integer (int32) |
encryptionOff required | integer (int32) |
antivirusOff required | integer (int32) |
diskLow required | integer (int32) |
InstalledPatchView #
| Field | Type |
|---|---|
vendorId required | string |
kb required | string |
installedAt required | string (date-time) (or null) |
removable required | boolean |
security required | boolean |
ItemChange #
| Field | Type |
|---|---|
key required | string |
type required | "package" | "script" | "rename" | "settings" | "admin_account" | "disk_encryption" | "domain_join" | "reboot" | "windows_update" | "check" | "cleanup" | "office" | "notify_user" | "microsoft_sign_in" | "regional" |
name required | string |
change required | "added" | "removed" | "changed" | "moved" |
moved required | boolean |
beforePosition required | integer (int32) (or null) |
afterPosition required | integer (int32) (or null) |
beforeSource required | object (or null) or ItemSource |
afterSource required | object (or null) or ItemSource |
fields required | array of FieldChange |
ItemSource #
| Field | Type |
|---|---|
blueprintId required | string (uuid) |
name required | string |
version required | integer (int32) (or null) |
JsonElement #
any
M365ConnectionView #
| Field | Type |
|---|---|
connected required | boolean |
tenantId required | string (uuid) (or null) |
cloud required | string (or null) |
ownApp required | boolean |
appClientId required | string (uuid) (or null) |
secretExpiresAt required | string (date-time) (or null) |
tenantName required | string (or null) |
consentedAt required | string (date-time) (or null) |
grantedPermissions required | array of string |
features required | array of M365FeatureStateView |
lastOkAt required | string (date-time) (or null) |
lastError required | string (or null) |
lastErrorAt required | string (date-time) (or null) |
mspAppReady required | boolean |
mspAppClouds required | array of string |
M365ConsentView #
| Field | Type |
|---|---|
url required | string |
expiresAt required | string (date-time) |
M365FeatureStateView #
| Field | Type |
|---|---|
key required | string |
name required | string |
ready required | boolean |
missing required | array of string |
MacDefaultSetting #
| Field | Type |
|---|---|
domain required | string |
key required | string |
stringValue | string (or null) |
integerValue | integer (int64) (or null) |
boolValue | boolean (or null) |
realValue | number (double) (or null) |
MembersView #
| Field | Type |
|---|---|
count required | integer (int32) |
devices required | array of DeviceGroupsMemberView |
MicrosoftSignIn #
| Field | Type |
|---|---|
tenantId | string (or null) |
oneDriveSignIn | boolean (or null) |
knownFolderMove | boolean (or null) |
keepFoldersInOneDrive | boolean (or null) |
edgeSignIn | boolean (or null) |
edgeSync | boolean (or null) |
edgeSkipFirstRun | boolean (or null) |
NamedView #
| Field | Type |
|---|---|
id required | string (uuid) |
name required | string |
NewHireList #
| Field | Type |
|---|---|
requests required | array of NewHireView |
available required | boolean |
microsoft365 required | DirectoryStatus |
NewHireNamed #
| Field | Type |
|---|---|
id required | string (uuid) |
name required | string |
NewHireStep #
| Field | Type |
|---|---|
key required | "account" | "licenses" | "groups" | "manager" | "device" | "shipping" | "setup" |
state required | "done" | "running" | "waiting" | "failed" | "skipped" |
label required | string |
detail required | string (or null) |
NewHireView #
| Field | Type |
|---|---|
id required | string (uuid) |
clientId required | string (uuid) |
siteId required | string (uuid) (or null) |
siteName required | string (or null) |
displayName required | string |
givenName required | string (or null) |
surname required | string (or null) |
jobTitle required | string (or null) |
department required | string (or null) |
startDate required | string (date) (or null) |
createAccount required | boolean |
userPrincipalName required | string (or null) |
usageLocation required | string (or null) |
managerUpn required | string (or null) |
licenses required | array of NewHireNamed |
groups required | array of NewHireNamed |
deviceMode required | "none" | "new" | "existing" |
serialNumber required | string (or null) |
deviceId required | string (uuid) (or null) |
deviceHostname required | string (or null) |
blueprintId required | string (uuid) (or null) |
blueprintName required | string (or null) |
shipTo required | string (or null) |
carrier required | string (or null) |
trackingNumber required | string (or null) |
trackingUrl required | string (or null) |
shippedAt required | string (date-time) (or null) |
note required | string (or null) |
state required | "queued" | "running" | "failed" | "done" | "cancelled" |
status required | "queued" | "creating_account" | "needs_attention" | "waiting_for_device" | "shipped" | "setting_up" | "ready" | "done" | "cancelled" |
steps required | array of NewHireStep |
lastError required | string (or null) |
passwordAvailable required | boolean |
passwordViewedAt required | string (date-time) (or null) |
createdAt required | string (date-time) |
createdBy required | string (or null) |
readyAt required | string (date-time) (or null) |
cancelledAt required | string (date-time) (or null) |
OnboardingEndpointsCheckView #
| Field | Type |
|---|---|
ordinal required | integer (int32) |
kind required | "windows_update" | "check" | "recovery_key_escrowed" | "admin_password_escrowed" | "restart_owed" |
name required | string |
state required | "pending" | "running" | "passed" | "failed" | "skipped" |
attempts required | integer (int32) |
round required | integer (int32) |
rounds required | integer (int32) |
stage required | string (or null) |
detail required | string (or null) |
nextAttemptAt required | string (date-time) (or null) |
startedAt required | string (date-time) (or null) |
finishedAt required | string (date-time) (or null) |
commandId required | string (uuid) (or null) |
skippedBy required | string (uuid) (or null) |
skipReason required | string (or null) |
OnboardingEndpointsStepView #
| Field | Type |
|---|---|
ordinal required | integer (int32) |
itemKey required | string |
kind required | string |
name required | string |
dependsOn required | array of integer (int32) |
state required | "pending" | "running" | "waiting_for_connector" | "succeeded" | "failed" | "blocked" | "skipped" |
attempts required | integer (int32) |
lastError required | string (or null) |
nextAttemptAt required | string (date-time) (or null) |
startedAt required | string (date-time) (or null) |
finishedAt required | string (date-time) (or null) |
commandId required | string (uuid) (or null) |
skippedBy required | string (uuid) (or null) |
continueOnFailure required | boolean |
retriedBy required | string (uuid) (or null) |
retriedAt required | string (date-time) (or null) |
answer required | "ok" | "yes" | "no" (or null) |
answeredByUser required | boolean (or null) |
onlyIfOrdinal required | integer (int32) (or null) |
onlyIfAnswer required | "yes" | "no" (or null) |
tries required | array of TryView |
signIns | object (or null) or SignInsView |
OnlyIf #
| Field | Type |
|---|---|
step required | string |
answer required | string |
OsPatchReport #
| Field | Type |
|---|---|
generatedAt required | string (date-time) |
clients required | array of ClientPatchReport |
devices required | array of DevicePatchReport |
truncated required | boolean |
OsPatchView #
| Field | Type |
|---|---|
id required | string (uuid) |
platform required | "windows" | "macos" |
vendorId required | string |
kb required | string |
kind required | string |
title required | string |
classification required | string |
severity required | string |
cves required | array of string |
rebootRequired required | boolean |
preview required | boolean |
outOfBand required | boolean |
publisher required | string |
releasedAt required | string (date-time) (or null) |
risk required | "low" | "standard" | "high" |
riskReason required | string |
decision required | string |
decisionNote required | string (or null) |
decidedAt required | string (date-time) (or null) |
approvals required | integer (int32) |
approvedByMe required | boolean |
status required | "auto" | "after_pilot" | "needs_approval" | "needs_second_approval" | "approved" | "declined" | "blocked" |
devices required | integer (int32) |
firstSeenAt required | string (date-time) |
reportedBy required | string (or null) |
exploitedCves required | array of string |
ransomware required | boolean |
dueAt required | string (date-time) |
PatchExceptionView #
| Field | Type |
|---|---|
type required | "exception" | "declined" | "blocked" | "pin" |
kind required | "os" | "app" |
holdId required | string (uuid) (or null) |
patchId required | string (uuid) (or null) |
title required | string |
reference required | string |
clientId required | string (uuid) (or null) |
clientName required | string (or null) |
deviceId required | string (uuid) (or null) |
hostname required | string (or null) |
wholeApp required | boolean |
reason required | string |
ownerId required | string (uuid) (or null) |
ownerName required | string (or null) |
createdBy required | string (or null) |
createdAt required | string (date-time) (or null) |
expiresAt required | string (date-time) (or null) |
state required | "active" | "ending_soon" | "no_end_date" |
PatchExceptionsReport #
| Field | Type |
|---|---|
generatedAt required | string (date-time) |
truncated required | boolean |
exceptions required | array of PatchExceptionView |
people required | array of NamedView |
PlanView #
| Field | Type |
|---|---|
platform required | string |
steps required | array of BlueprintEndpointsStepView |
checks required | array of BlueprintEndpointsCheckView |
PreviewItem #
| Field | Type |
|---|---|
key required | string |
type required | "package" | "script" | "rename" | "settings" | "admin_account" | "disk_encryption" | "domain_join" | "reboot" | "windows_update" | "check" | "cleanup" | "office" | "notify_user" | "microsoft_sign_in" | "regional" |
name required | string |
locked required | boolean |
source required | ItemSource |
overrides required | object (or null) or ItemSource |
PreviewView #
| Field | Type |
|---|---|
baseVersion required | integer (int32) (or null) |
items required | array of PreviewItem |
plans required | map of array of BlueprintEndpointsStepView |
problems required | array of Problem |
checks required | map of array of BlueprintEndpointsCheckView |
Problem #
| Field | Type |
|---|---|
field required | string |
message required | string |
RegisterAllView #
| Field | Type |
|---|---|
queued required | integer (int32) |
RegistrySetting #
| Field | Type |
|---|---|
key required | string |
name | string (or null) |
kind | string (or null) |
stringValue | string (or null) |
numberValue | integer (or null) |
multiValue | array of string (or null) |
wow64 | boolean (or null) |
remove | boolean (or null) |
Report #
| Field | Type |
|---|---|
generatedAt required | string (date-time) |
users required | array of UserView |
apiKeys required | array of AccessReviewKeyView |
RingView #
| Field | Type |
|---|---|
deviceId required | string (uuid) |
hostname required | string |
clientId required | string (uuid) (or null) |
ring required | string |
chosen required | boolean |
RoleView #
| Field | Type |
|---|---|
role required | string |
scope required | string |
ScriptParameter #
| Field | Type |
|---|---|
name required | string |
value required | string |
SecurityCheck #
| Field | Type |
|---|---|
kind required | "encryption" | "antivirus" | "firewall" | "patches" | "admins" | "boot" | "checkin" |
title required | string |
state required | "pass" | "partial" | "fail" | "unknown" | "not_applicable" |
weight required | integer (int32) |
earned required | integer (int32) |
detail required | string |
SecurityCheckCount #
| Field | Type |
|---|---|
kind required | "encryption" | "antivirus" | "firewall" | "patches" | "admins" | "boot" | "checkin" |
title required | string |
failing required | integer (int32) |
partial required | integer (int32) |
SecurityFixOffer #
| Field | Type |
|---|---|
check required | "encryption" | "antivirus" | "firewall" | "patches" | "admins" | "boot" | "checkin" |
fix required | "firewall_on" | "antivirus_on" | "encryption_on" | "encryption_off" | "patches_install" | "patches_scan" | "admin_create" | "admin_remove" | "recheck" |
label required | string |
detail required | string |
passkey required | boolean |
username required | string (or null) |
unavailable required | string (or null) |
SecurityGuide #
| Field | Type |
|---|---|
check required | "encryption" | "antivirus" | "firewall" | "patches" | "admins" | "boot" | "checkin" |
title required | string |
steps required | array of string |
SecurityReport #
| Field | Type |
|---|---|
generatedAt required | string (date-time) |
score required | integer (int32) (or null) |
grade required | "good" | "fair" | "at_risk" (or null) |
devices required | integer (int32) |
clients required | array of ClientSecurityLine |
checks required | array of SecurityCheckCount |
deviceLines required | array of DeviceSecurityLine |
truncated required | boolean |
SelfServiceAppView #
| Field | Type |
|---|---|
id required | string (uuid) |
packageId required | string (uuid) |
name required | string |
platform required | string |
publisher required | string |
needsApproval required | boolean |
note required | string |
addedAt required | string (date-time) |
addedBy required | string (or null) |
archived required | boolean |
SelfServiceRequestView #
| Field | Type |
|---|---|
id required | string (uuid) |
deviceId required | string (uuid) |
hostname required | string |
packageId required | string (uuid) (or null) |
packageName required | string |
requestedBy required | string |
reason required | string |
neededApproval required | boolean |
state required | string |
createdAt required | string (date-time) |
decidedAt required | string (date-time) (or null) |
decidedBy required | string (or null) |
decisionNote required | string |
jobId required | string (uuid) (or null) |
SelfServiceView #
| Field | Type |
|---|---|
available required | boolean |
enabled required | boolean |
approverEmails required | array of string |
apps required | array of SelfServiceAppView |
requests required | array of SelfServiceRequestView |
pending required | integer (int32) |
ServiceSetting #
| Field | Type |
|---|---|
name required | string |
startup | string (or null) |
state | string (or null) |
SessionView #
| Field | Type |
|---|---|
id required | string (uuid) |
deviceId required | string (uuid) |
blueprintId required | string (uuid) |
blueprintName required | string |
versionId required | string (uuid) (or null) |
version required | integer (int32) (or null) |
platform required | "windows" | "macos" |
state required | "running" | "blocked" | "succeeded" | "failed" | "cancelled" |
error required | string (or null) |
startedBy required | string (uuid) (or null) |
createdAt required | string (date-time) |
updatedAt required | string (date-time) |
finishedAt required | string (date-time) (or null) |
steps required | array of OnboardingEndpointsStepView |
phase required | "steps" | "verifying" |
checks required | array of OnboardingEndpointsCheckView |
purpose required | "onboarding" | "standard" | "addon" | "addon_check" | "user_apps" |
status required | "running" | "blocked" | "verifying" | "not_ready" | "succeeded" | "failed" | "cancelled" |
SignInsView #
| Field | Type |
|---|---|
installed required | integer (int32) |
failed required | integer (int32) |
running required | integer (int32) |
StandardClientSummary #
| Field | Type |
|---|---|
clientId required | string (uuid) (or null) |
clientName required | string (or null) |
enabled required | boolean |
devices required | integer (int32) |
inStandard required | integer (int32) |
fixed required | integer (int32) |
failed required | integer (int32) |
notChecked required | integer (int32) |
StatusLinkCreated #
| Field | Type |
|---|---|
link required | StatusLinkView |
url required | string |
StatusLinkList #
| Field | Type |
|---|---|
links required | array of StatusLinkView |
available required | boolean |
StatusLinkView #
| Field | Type |
|---|---|
id required | string (uuid) |
clientId required | string (uuid) |
label required | string |
state required | string |
createdAt required | string (date-time) |
createdBy required | string (or null) |
expiresAt required | string (date-time) (or null) |
revokedAt required | string (date-time) (or null) |
lastViewedAt required | string (date-time) (or null) |
views required | integer (int32) |
revokedForPlan required | boolean |
TagCount #
| Field | Type |
|---|---|
tag required | string |
devices required | integer (int32) |
TeamEndpointsMemberView #
| Field | Type |
|---|---|
id required | string (uuid) |
email required | string |
displayName required | string |
disabled required | boolean |
grants required | array of GrantView |
recoveryLocked required | boolean |
ssoLinked required | boolean |
hasPasskey required | boolean |
hasRecovery required | boolean |
TryView #
| Field | Type |
|---|---|
commandId required | string (uuid) |
state required | string |
exitCode required | integer (int32) (or null) |
startedAt required | string (date-time) (or null) |
finishedAt required | string (date-time) (or null) |
error required | string |
UserView #
| Field | Type |
|---|---|
id required | string (uuid) |
email required | string |
displayName required | string |
status required | string |
roles required | array of RoleView |
passkeys required | integer (int32) |
deviceBoundPasskeys required | integer (int32) |
ssoLinked required | boolean |
mfa required | string |
createdAt required | string (date-time) |
disabledAt required | string (date-time) (or null) |
lastSignInAt required | string (date-time) (or null) |
lastActiveAt required | string (date-time) (or null) |
stale required | boolean |
VersionDetailView #
| Field | Type |
|---|---|
version required | BlueprintEndpointsVersionView |
document required | BlueprintDocument |
items required | array of PreviewItem |
checks required | array of BlueprintItem |
WakeAdapterView #
| Field | Type |
|---|---|
name required | string |
macAddress required | string |
kind required | "wired" | "wireless" | "other" |
up required | boolean |
ipv4 required | array of string |
WakeRelayView #
| Field | Type |
|---|---|
deviceId required | string (uuid) |
hostname required | string |
WakeView #
| Field | Type |
|---|---|
canWake required | boolean |
reason required | "online" | "retired" | "agent_too_old" | "no_mac" | "no_network" | "no_relay" (or null) |
message required | string (or null) |
adapters required | array of WakeAdapterView |
relays required | array of WakeRelayView |
WarrantyView #
| Field | Type |
|---|---|
deviceId required | string (uuid) |
vendor required | string |
looksUp required | boolean |
source required | string (or null) |
lookupState required | string (or null) |
startDate required | string (date) (or null) |
endDate required | string (date) (or null) |
shipDate required | string (date) (or null) |
purchaseDate required | string (date) (or null) |
description required | string (or null) |
state required | string |
daysLeft required | integer (int32) (or null) |
checkedAt required | string (date-time) (or null) |
nextCheckAt required | string (date-time) (or null) |
lastError required | string (or null) |
ageFromDate required | string (date) |
ageFrom required | string |
ageYears required | number (double) |
refreshDue required | string (date) |
bucket required | string |
Last updated 2026-11-14. Something wrong or missing? Email [email protected].