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 #

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)

FieldType
name requiredstring

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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (uuid)

Body (JSON)

FieldType
siteId requiredstring (uuid) (or null)

200 returns AbmLinkView

POST /clients/{clientId}/abm/sync #

Read ABM's Macs now (also done every hour).

Scope: clients:write

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (uuid)

Body (JSON)

FieldType
token requiredstring
siteIdstring (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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (uuid)

Body (JSON)

FieldType
autoRegister requiredboolean (or null)
groupTag requiredstring (or null)
removeOnRetire requiredboolean (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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (uuid)

Body (JSON)

FieldType
values requiredmap 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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (uuid)

Body (JSON)

FieldType
tenantId requiredstring (or null)
cloudstring (or null)
appClientIdstring (or null)
secretstring (or null)
secretExpiresAtstring (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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (uuid)

200 returns M365ConsentView

POST /clients/{clientId}/m365/test #

Sign in to the tenant now and read the app's permissions.

Scope: clients:write

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (uuid)

Body (JSON)

FieldType
givenName requiredstring (or null)
surname requiredstring (or null)
displayName requiredstring (or null)
createAccount requiredboolean
userPrincipalName requiredstring (or null)
usageLocationstring (or null)
jobTitlestring (or null)
departmentstring (or null)
startDatestring (date) (or null)
managerUpnstring (or null)
licensesarray of NewHireNamed (or null)
groupsarray of NewHireNamed (or null)
deviceModestring
serialNumberstring (or null)
deviceIdstring (uuid) (or null)
siteIdstring (uuid) (or null)
blueprintIdstring (uuid) (or null)
shipTostring (or null)
carrierstring (or null)
trackingNumberstring (or null)
notestring (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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (uuid)

200 returns SelfServiceView

GET /clients/{clientId}/sites #

Scope: clients:read

ParameterInType
clientId requiredpathstring (uuid)

200 returns array of NamedView

POST /clients/{clientId}/sites #

Scope: clients:write

ParameterInType
clientId requiredpathstring (uuid)

Body (JSON)

FieldType
name requiredstring

201 returns NamedView

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

ParameterInType
clientId requiredpathstring (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

ParameterInType
clientId requiredpathstring (uuid)

Body (JSON)

FieldType
label requiredstring (or null)
expiresInDays requiredinteger (int32) (or null)

201 returns StatusLinkCreated

Revoke a status page link: it stops working at once. Needs Manage clients on the client; audited.

Scope: clients:write

ParameterInType
clientId requiredpathstring (uuid)
linkId requiredpathstring (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

ParameterInType
beforequeryinteger (int64)
limitqueryinteger (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

ParameterInType
n requiredpathinteger (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

ParameterInType
formatquerystring
fromquerystring (date)
toquerystring (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

ParameterInType
limitqueryinteger (int32)
afterquerystring
searchquerystring
statequerystring
tagquerystring
groupquerystring (uuid)
clientquerystring (uuid)
fieldquerystring
fieldValuequerystring

200 returns DevicePage

POST /devices/tags #

Add and remove tags on up to 200 devices at once.

Scope: devices:organize

Body (JSON)

FieldType
deviceIds requiredarray of string (uuid) (or null)
add requiredarray of string (or null)
remove requiredarray of string (or null)

200 returns BulkTagsView

GET /devices/{deviceId} #

One device with its latest inventory.

Scope: devices:read

ParameterInType
deviceId requiredpathstring (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

ParameterInType
deviceId requiredpathstring (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

ParameterInType
deviceId requiredpathstring (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

ParameterInType
deviceId requiredpathstring (uuid)

200 returns DeviceBlueprintView

GET /devices/{deviceId}/commands #

Recent commands for a device.

Scope: devices:read

ParameterInType
deviceId requiredpathstring (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

ParameterInType
deviceId requiredpathstring (uuid)

200 returns DeviceValuesView

GET /devices/{deviceId}/onboarding #

A device's latest onboarding session and its steps.

Scope: devices:read

ParameterInType
deviceId requiredpathstring (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

ParameterInType
deviceId requiredpathstring (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

ParameterInType
deviceId requiredpathstring (uuid)

Body (JSON)

FieldType
ring requiredstring (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

ParameterInType
deviceId requiredpathstring (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

ParameterInType
deviceId requiredpathstring (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

ParameterInType
deviceId requiredpathstring (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

ParameterInType
deviceId requiredpathstring (uuid)

Body (JSON)

FieldType
tags requiredarray 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

ParameterInType
deviceId requiredpathstring (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

ParameterInType
deviceId requiredpathstring (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)

FieldType
name requiredstring (or null)
description requiredstring (or null)
clientId requiredstring (uuid) (or null)
match required"all" | "any" (or null)
rules requiredarray 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)

FieldType
clientId requiredstring (uuid) (or null)
match required"all" | "any" (or null)
rules requiredarray of GroupRule (or null)

200 returns MembersView

GET /device-groups/{groupId} #

One group.

Scope: devices:read

ParameterInType
groupId requiredpathstring (uuid)

200 returns GroupView

PUT /device-groups/{groupId} #

Change a group's name, description, client or rules.

Scope: devices:organize

ParameterInType
groupId requiredpathstring (uuid)

Body (JSON)

FieldType
name requiredstring (or null)
description requiredstring (or null)
clientId requiredstring (uuid) (or null)
match required"all" | "any" (or null)
rules requiredarray of GroupRule (or null)

200 returns GroupView

DELETE /device-groups/{groupId} #

Delete a group. Its devices don't change.

Scope: devices:organize

ParameterInType
groupId requiredpathstring (uuid)

204 No Content

GET /device-groups/{groupId}/devices #

The group's devices right now (those you can see).

Scope: devices:read

ParameterInType
groupId requiredpathstring (uuid)
limitqueryinteger (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

ParameterInType
sessionId requiredpathstring (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

ParameterInType
statequerystring
clientIdquerystring (uuid)
deviceIdquerystring (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

ParameterInType
clientIdquerystring (uuid)
devicesquerystring

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

ParameterInType
clientIdquerystring (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

ParameterInType
clientIdquerystring (uuid)

200 returns PatchExceptionsReport

503 Service Unavailable

GET /patching/exceptions.csv #

The exceptions report as CSV, for auditors.

Scope: devices:read

ParameterInType
clientIdquerystring (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

ParameterInType
clientIdquerystring (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

ParameterInType
clientIdquerystring (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

ParameterInType
clientIdquerystring (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

ParameterInType
clientIdquerystring (uuid)
devicesquerystring

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

ParameterInType
clientIdquerystring (uuid)

200 returns CSV (text/csv)

503 Service Unavailable

GET /patching/rings #

Each device's patch ring (?clientId= for one client).

Scope: devices:read

ParameterInType
clientIdquerystring (uuid)

200 returns array of RingView

Blueprints #

GET /blueprint-versions/{versionId} #

One version: what was published, resolved, and its signed plans.

Scope: blueprints:read

ParameterInType
versionId requiredpathstring (uuid)

200 returns VersionDetailView

GET /blueprints #

Templates and client and site blueprints (?clientId= for one client's).

Scope: blueprints:read

ParameterInType
clientIdquerystring (uuid)
archivedqueryboolean

200 returns array of BlueprintView

GET /blueprints/{blueprintId} #

A blueprint with its draft.

Scope: blueprints:read

ParameterInType
blueprintId requiredpathstring (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

ParameterInType
blueprintId requiredpathstring (uuid)
fromquerystring
toquerystring

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

ParameterInType
blueprintId requiredpathstring (uuid)

200 returns PreviewView

GET /blueprints/{blueprintId}/versions #

Published and pending versions, newest first.

Scope: blueprints:read

ParameterInType
blueprintId requiredpathstring (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

ParameterInType
entityquerystring

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

ParameterInType
clientIdquerystring (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 #

FieldType
step requiredstring
state requiredstring
error requiredstring (or null)
doneAt requiredstring (date-time) (or null)

AbmLinkView #

FieldType
configured requiredboolean
connected requiredboolean
siteId requiredstring (uuid) (or null)
orgName requiredstring (or null)
serverName requiredstring (or null)
tokenExpiresAt requiredstring (date-time) (or null)
syncedAt requiredstring (date-time) (or null)
syncing requiredboolean
lastError requiredstring (or null)
lastErrorAt requiredstring (date-time) (or null)
connectedAt requiredstring (date-time) (or null)
pushReady requiredboolean
macs requiredarray of AbmMacView

AbmMacView #

FieldType
serial requiredstring
model requiredstring (or null)
description requiredstring (or null)
profileStatus requiredstring (or null)
hasEnlistProfile requiredboolean
assignError requiredstring (or null)
mdmState requiredstring (or null)
enrolledAt requiredstring (date-time) (or null)
configuredAt requiredstring (date-time) (or null)
lastError requiredstring (or null)
deviceId requiredstring (uuid) (or null)
stage requiredstring
steps requiredarray of AbmCommandView

AccessReviewKeyView #

FieldType
id requiredstring (uuid)
name requiredstring
scopes requiredarray of string
createdBy requiredstring
createdAt requiredstring (date-time)
expiresAt requiredstring (date-time)
lastUsedAt requiredstring (date-time) (or null)
status requiredstring

AnchorKeyView #

FieldType
keyId requiredstring
algorithm requiredstring
publicKey requiredstring

AnchorView #

FieldType
n requiredinteger (int32)
throughSeq requiredinteger (int64)
headHash requiredstring
anchoredAt requiredstring (date-time)
reason requiredstring
prevAnchorSha256 requiredstring (or null)
body requiredstring
keyId requiredstring
signature requiredstring
matchesLog requiredboolean
linksToPrevious requiredboolean
archived requiredboolean

AnchorsView #

FieldType
available requiredboolean
keyId requiredstring
exportedOutside requiredboolean
anchors requiredarray of AnchorView

ArchiveView #

FieldType
n requiredinteger (int32)
fromSeq requiredinteger (int64)
throughSeq requiredinteger (int64)
entries requiredinteger (int64)
sha256 requiredstring
size requiredinteger (int64)
archivedAt requiredstring (date-time)

ArchivesView #

FieldType
available requiredboolean
prunedThroughSeq requiredinteger (int64) (or null)
archives requiredarray of ArchiveView

AuditLogVerifyView #

FieldType
intact requiredboolean
events requiredinteger (int64)
brokenAt requiredinteger (int64) (or null)

AutopilotDeviceView #

FieldType
deviceId requiredstring (uuid)
hostname requiredstring (or null)
serial requiredstring
hashCaptured requiredboolean
capturedAt requiredstring (date-time) (or null)
captureError requiredstring (or null)
captureErrorAt requiredstring (date-time) (or null)
state requiredstring
groupTag requiredstring (or null)
error requiredstring (or null)
requestedAt requiredstring (date-time) (or null)
registeredAt requiredstring (date-time) (or null)

AutopilotSettingsView #

FieldType
autoRegister requiredboolean
groupTag requiredstring (or null)
removeOnRetire requiredboolean

AutopilotTenantView #

FieldType
connected requiredboolean
ready requiredboolean
tenantName requiredstring (or null)
problem requiredstring (or null)

BlueprintDetailView #

FieldType
blueprint requiredBlueprintView
draft requiredBlueprintDocument
editingobject (or null) or EditSessionView

BlueprintDocument #

FieldType
itemsarray of BlueprintItem (or null)
removearray of string (or null)

BlueprintEndpointsCheckView #

FieldType
ordinal requiredinteger (int32)
itemKey requiredstring
kind required"windows_update" | "check"
name requiredstring
rounds requiredinteger (int32)

BlueprintEndpointsStepView #

FieldType
ordinal requiredinteger (int32)
itemKey requiredstring
kind requiredstring
name requiredstring
dependsOn requiredarray of integer (int32)
timeoutSeconds requiredinteger (int32)
stepSha256 requiredstring (or null)

BlueprintEndpointsVersionView #

FieldType
id requiredstring (uuid)
blueprintId requiredstring (uuid)
version requiredinteger (int32)
state required"pending" | "published" | "discarded"
createdAt requiredstring (date-time)
publishedAt requiredstring (date-time) (or null)
baseVersionId requiredstring (uuid) (or null)
expiresAt requiredstring (date-time) (or null)
digestSha256 requiredstring
approvedBy requiredarray of string (uuid)
approvalsRequired requiredinteger (int32) (or null)
plans requiredarray of PlanView

BlueprintItem #

FieldType
key requiredstring
type required"package" | "script" | "rename" | "settings" | "admin_account" | "disk_encryption" | "domain_join" | "reboot" | "windows_update" | "check" | "cleanup" | "office" | "notify_user" | "microsoft_sign_in" | "regional"
namestring (or null)
lockedboolean (or null)
afterarray of string (or null)
timeoutSecondsinteger (int32) (or null)
packageVersionIdstring (uuid) (or null)
categorystring (or null)
languagestring (or null)
scriptstring (or null)
runAsstring (or null)
parametersarray of ScriptParameter (or null)
messagestring (or null)
nameTemplatestring (or null)
settingsarray of BlueprintSetting (or null)
usernamestring (or null)
fullNamestring (or null)
hiddenboolean (or null)
passwordLengthinteger (int32) (or null)
disableBuiltinAdministratorboolean (or null)
encryptionMethodstring (or null)
usedSpaceOnlyboolean (or null)
domainstring (or null)
joinMethodstring (or null)
oustring (or null)
roundsinteger (int32) (or null)
checkstring (or null)
servicestring (or null)
removeOfficeboolean (or null)
removeAppsarray of string (or null)
officeProductstring (or null)
appleAccountstring (or null)
continueOnFailureboolean (or null)
titlestring (or null)
buttonsstring (or null)
defaultAnswerstring (or null)
answerMinutesinteger (int32) (or null)
onlyIfobject (or null) or OnlyIf
installKeysarray of string (or null)
customFieldsarray of string (or null)
microsoftSignInobject (or null) or MicrosoftSignIn
localestring (or null)
keyboardLayoutstring (or null)
homeLocationinteger (int32) (or null)
timeZonestring (or null)

BlueprintSetting #

FieldType
registryobject (or null) or RegistrySetting
serviceobject (or null) or ServiceSetting
macDefaultobject (or null) or MacDefaultSetting

BlueprintView #

FieldType
id requiredstring (uuid)
name requiredstring
description requiredstring
clientId requiredstring (uuid) (or null)
siteId requiredstring (uuid) (or null)
baseBlueprintId requiredstring (uuid) (or null)
publishedVersion requiredinteger (int32) (or null)
publishedAt requiredstring (date-time) (or null)
hasUnpublishedChanges requiredboolean
draftUpdatedAt requiredstring (date-time)
createdAt requiredstring (date-time)
archivedAt requiredstring (date-time) (or null)
addOnTagstring (or null)
publishedPlatformsarray of string (or null)

BulkTagsView #

FieldType
changed requiredinteger (int32)

ClientAutopilotView #

FieldType
settings requiredAutopilotSettingsView
tenant requiredAutopilotTenantView
windowsDevices requiredinteger (int32)
devices requiredarray of AutopilotDeviceView

ClientPatchReport #

FieldType
clientId requiredstring (uuid) (or null)
clientName requiredstring
devices requiredinteger (int32)
fullyPatched requiredinteger (int32)
percent requiredinteger (int32) (or null)
notScanned requiredinteger (int32)
missingPatches requiredinteger (int32)
pendingApproval requiredinteger (int32)
failedDevices requiredinteger (int32)
waitingDevices requiredinteger (int32)
nextDeadline requiredstring (date-time) (or null)
overdueDevicesinteger (int32)

ClientSecurityLine #

FieldType
clientId requiredstring (uuid) (or null)
clientName requiredstring
devices requiredinteger (int32)
unscored requiredinteger (int32)
score requiredinteger (int32) (or null)
grade required"good" | "fair" | "at_risk" (or null)
good requiredinteger (int32)
fair requiredinteger (int32)
atRisk requiredinteger (int32)
checks requiredarray of SecurityCheckCount

ClientView #

FieldType
id requiredstring (uuid)
name requiredstring
activeDevices requiredinteger (int32) (or null)

CommandView #

FieldType
id requiredstring (uuid)
deviceId requiredstring (uuid)
jobId requiredstring (uuid) (or null)
kind requiredstring
state requiredstring
createdAt requiredstring (date-time)
expiresAt requiredstring (date-time)
sentAt requiredstring (date-time) (or null)
startedAt requiredstring (date-time) (or null)
finishedAt requiredstring (date-time) (or null)
exitCode requiredinteger (int32) (or null)
rebootRequired requiredboolean
detail requiredstring (or null)

CompareSide #

FieldType
versionId requiredstring (uuid) (or null)
version requiredinteger (int32) (or null)
state required"draft" | "restored" | "pending" | "published" | "discarded"
at requiredstring (date-time) (or null)
baseName requiredstring (or null)
baseVersion requiredinteger (int32) (or null)

CompareView #

FieldType
from requiredCompareSide
to requiredCompareSide
changes requiredarray of ItemChange
unchanged requiredinteger (int32)

CustomFieldValueView #

FieldType
fieldId requiredstring (uuid)
name requiredstring
label requiredstring
type required"text" | "number" | "yes_no" | "date" | "choice"
choices requiredarray of string
value requiredstring (or null)
setBy required"person" | "script" (or null)
updatedAt requiredstring (date-time) (or null)

CustomFieldView #

FieldType
id requiredstring (uuid)
entity required"device" | "client"
name requiredstring
label requiredstring
description requiredstring
type required"text" | "number" | "yes_no" | "date" | "choice"
choices requiredarray of string
defaultValue requiredstring (or null)
scriptsCanSet requiredboolean
variable requiredstring
updatedAt requiredstring (date-time)

CveReport #

FieldType
cve requiredstring
severity requiredstring
devices requiredinteger (int32)
patches requiredarray of string
hostnames requiredarray of string
declined requiredboolean
exploited requiredboolean
ransomware requiredboolean
exploitedSince requiredstring (date) (or null)
fixBy requiredstring (date) (or null)

CveReportList #

FieldType
cves requiredarray of CveReport
truncated requiredboolean
exploitedListAtstring (date-time) (or null)

DeviceAddOnView #

FieldType
blueprintId requiredstring (uuid)
name requiredstring
tag requiredstring
version requiredinteger (int32) (or null)
state required"applied" | "failed" | "running" | "waiting" | "no_plan"
lastRunAt requiredstring (date-time) (or null)
lastSessionId requiredstring (uuid) (or null)

DeviceAutopilotView #

FieldType
device requiredAutopilotDeviceView
tenant requiredAutopilotTenantView

DeviceBlueprintView #

FieldType
blueprintId requiredstring (uuid)
name requiredstring
version requiredBlueprintEndpointsVersionView

DeviceDetailView #

FieldType
device requiredDeviceView
inventoryRevision requiredinteger (int64)
inventoryAt requiredstring (date-time) (or null)
inventory requiredobject (or null) or JsonElement

DeviceEndpointsDeviceCounts #

FieldType
active requiredinteger (int32)
online requiredinteger (int32)

DeviceGroupsMemberView #

FieldType
id requiredstring (uuid)
hostname requiredstring
platform required"windows" | "macos"
clientId requiredstring (uuid) (or null)
serialNumber requiredstring
model requiredstring

DeviceOsPatchesView #

FieldType
deviceId requiredstring (uuid)
hostname requiredstring
scannedAt requiredstring (date-time) (or null)
scanning requiredboolean
available requiredarray of DevicePatchView
installed requiredarray of InstalledPatchView

DevicePage #

FieldType
devices requiredarray of DeviceView
next requiredstring (or null)
counts requiredobject (or null) or DeviceEndpointsDeviceCounts

DevicePatchReport #

FieldType
deviceId requiredstring (uuid)
hostname requiredstring
clientId requiredstring (uuid) (or null)
clientName requiredstring
platform requiredstring
ring requiredstring
state requiredstring
scannedAt requiredstring (date-time) (or null)
missing requiredinteger (int32)
pendingApproval requiredinteger (int32)
failed requiredinteger (int32)
openCves requiredinteger (int32)
deadline requiredstring (date-time) (or null)
overdueinteger (int32)
nextDuestring (date-time) (or null)

DevicePatchView #

FieldType
patch requiredOsPatchView
fromVersion requiredstring
toVersion requiredstring
size requiredinteger (int64)
install requiredstring (or null)
installSentAt requiredstring (date-time) (or null)

DeviceRemoteToolView #

FieldType
toolId requiredstring (uuid)
name requiredstring
idLabel requiredstring
needsDeviceId requiredboolean
opensInBrowser requiredboolean
remoteId requiredstring (or null)
remoteIdUpdatedAt requiredstring (date-time) (or null)
remoteIdUpdatedBy requiredstring (or null)
remoteIdSource required"typed" | "agent" (or null)
agentRemoteId requiredstring (or null)
readsIdFrom requiredstring (or null)

DeviceSecurityLine #

FieldType
deviceId requiredstring (uuid)
hostname requiredstring
platform required"windows" | "macos"
clientId requiredstring (uuid) (or null)
clientName requiredstring
score requiredinteger (int32) (or null)
grade required"good" | "fair" | "at_risk" (or null)
failing requiredarray of string
partial requiredarray of string

DeviceSecurityView #

FieldType
deviceId requiredstring (uuid)
hostname requiredstring
platform required"windows" | "macos"
clientId requiredstring (uuid) (or null)
clientName requiredstring
score requiredinteger (int32) (or null)
grade required"good" | "fair" | "at_risk" (or null)
checks requiredarray of SecurityCheck
generatedAt requiredstring (date-time)
fixes requiredarray of SecurityFixOffer
guides requiredarray of SecurityGuide

DeviceStandardView #

FieldType
deviceId requiredstring (uuid)
state required"in_standard" | "fixed" | "failed" (or null)
checkedAt requiredstring (date-time) (or null)
enabled requiredboolean
latest requiredobject (or null) or SessionView

DeviceValuesView #

FieldType
device requiredarray of CustomFieldValueView
client requiredarray of CustomFieldValueView
clientId requiredstring (uuid) (or null)

DeviceView #

FieldType
id requiredstring (uuid)
hostname requiredstring
platform required"windows" | "macos"
clientId requiredstring (uuid) (or null)
siteId requiredstring (uuid) (or null)
serialNumber requiredstring
manufacturer requiredstring
model requiredstring
osVersion requiredstring
agentVersion requiredstring
isVirtualMachine requiredboolean
enrolledAt requiredstring (date-time)
lastSeenAt requiredstring (date-time) (or null)
online requiredboolean
retiredAt requiredstring (date-time) (or null)
certificateNotAfter requiredstring (date-time)
renewalPending requiredboolean
renewRequestedAt requiredstring (date-time) (or null)
tags requiredarray of string
standardState required"in_standard" | "fixed" | "failed" (or null)
standardCheckedAt requiredstring (date-time) (or null)
blueprintIdstring (uuid) (or null)
assignedUserstring (or null)

DeviceWarrantyResponse #

FieldType
available requiredboolean
warranty requiredobject (or null) or WarrantyView

DirectoryGroup #

FieldType
id requiredstring (uuid)
name requiredstring
kind requiredstring

DirectoryLicense #

FieldType
skuId requiredstring (uuid)
name requiredstring
available requiredinteger (int32)

DirectoryOptions #

FieldType
domains requiredarray of string
licenses requiredarray of DirectoryLicense
groups requiredarray of DirectoryGroup
groupsTruncated requiredboolean

DirectoryStatus #

FieldType
connected requiredboolean
missing requiredarray of string
message requiredstring (or null)

EditSessionView #

FieldType
expiresAt requiredstring (date-time)

EventView #

FieldType
seq requiredinteger (int64)
occurredAt requiredstring (date-time)
actorKind requiredstring
actorUserId requiredstring (uuid) (or null)
action requiredstring
targetType requiredstring (or null)
targetId requiredstring (uuid) (or null)
clientId requiredstring (uuid) (or null)
ip requiredstring (or null)
details requiredJsonElement
hash requiredstring

FieldChange #

FieldType
field requiredstring
label requiredstring
before requiredstring (or null)
after requiredstring (or null)

GrantView #

FieldType
id requiredstring (uuid)
role requiredstring
clientId requiredstring (uuid) (or null)
siteId requiredstring (uuid) (or null)

GroupRule #

FieldType
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)
valuestring (or null)
idsarray of string (uuid) (or null)
namestring (or null)

GroupView #

FieldType
id requiredstring (uuid)
name requiredstring
description requiredstring
clientId requiredstring (uuid) (or null)
match required"all" | "any"
rules requiredarray of GroupRule
deviceCount requiredinteger (int32)
updatedAt requiredstring (date-time)

HealthAlertView #

FieldType
id requiredstring (uuid)
deviceId requiredstring (uuid)
hostname requiredstring
platform required"windows" | "macos"
clientId requiredstring (uuid) (or null)
clientName requiredstring (or null)
kind required"offline" | "encryption_off" | "antivirus_off" | "disk_low"
title requiredstring
state required"pending" | "open" | "resolved"
detail requiredstring
firstSeenAt requiredstring (date-time)
openedAt requiredstring (date-time) (or null)
lastCheckedAt requiredstring (date-time)
resolvedAt requiredstring (date-time) (or null)
resolvedReason required"fixed" | "retired" | "turned_off" (or null)
acknowledgedAt requiredstring (date-time) (or null)
acknowledgedBy requiredstring (or null)
ticketProvider required"halo" | "psa" (or null)
ticketId requiredinteger (int64) (or null)
ticketError requiredstring (or null)

HealthClientSummary #

FieldType
clientId requiredstring (uuid) (or null)
clientName requiredstring (or null)
devices requiredinteger (int32)
healthy requiredinteger (int32)
offline requiredinteger (int32)
encryptionOff requiredinteger (int32)
antivirusOff requiredinteger (int32)
diskLow requiredinteger (int32)

InstalledPatchView #

FieldType
vendorId requiredstring
kb requiredstring
installedAt requiredstring (date-time) (or null)
removable requiredboolean
security requiredboolean

ItemChange #

FieldType
key requiredstring
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 requiredstring
change required"added" | "removed" | "changed" | "moved"
moved requiredboolean
beforePosition requiredinteger (int32) (or null)
afterPosition requiredinteger (int32) (or null)
beforeSource requiredobject (or null) or ItemSource
afterSource requiredobject (or null) or ItemSource
fields requiredarray of FieldChange

ItemSource #

FieldType
blueprintId requiredstring (uuid)
name requiredstring
version requiredinteger (int32) (or null)

JsonElement #

any

M365ConnectionView #

FieldType
connected requiredboolean
tenantId requiredstring (uuid) (or null)
cloud requiredstring (or null)
ownApp requiredboolean
appClientId requiredstring (uuid) (or null)
secretExpiresAt requiredstring (date-time) (or null)
tenantName requiredstring (or null)
consentedAt requiredstring (date-time) (or null)
grantedPermissions requiredarray of string
features requiredarray of M365FeatureStateView
lastOkAt requiredstring (date-time) (or null)
lastError requiredstring (or null)
lastErrorAt requiredstring (date-time) (or null)
mspAppReady requiredboolean
mspAppClouds requiredarray of string

M365ConsentView #

FieldType
url requiredstring
expiresAt requiredstring (date-time)

M365FeatureStateView #

FieldType
key requiredstring
name requiredstring
ready requiredboolean
missing requiredarray of string

MacDefaultSetting #

FieldType
domain requiredstring
key requiredstring
stringValuestring (or null)
integerValueinteger (int64) (or null)
boolValueboolean (or null)
realValuenumber (double) (or null)

MembersView #

FieldType
count requiredinteger (int32)
devices requiredarray of DeviceGroupsMemberView

MicrosoftSignIn #

FieldType
tenantIdstring (or null)
oneDriveSignInboolean (or null)
knownFolderMoveboolean (or null)
keepFoldersInOneDriveboolean (or null)
edgeSignInboolean (or null)
edgeSyncboolean (or null)
edgeSkipFirstRunboolean (or null)

NamedView #

FieldType
id requiredstring (uuid)
name requiredstring

NewHireList #

FieldType
requests requiredarray of NewHireView
available requiredboolean
microsoft365 requiredDirectoryStatus

NewHireNamed #

FieldType
id requiredstring (uuid)
name requiredstring

NewHireStep #

FieldType
key required"account" | "licenses" | "groups" | "manager" | "device" | "shipping" | "setup"
state required"done" | "running" | "waiting" | "failed" | "skipped"
label requiredstring
detail requiredstring (or null)

NewHireView #

FieldType
id requiredstring (uuid)
clientId requiredstring (uuid)
siteId requiredstring (uuid) (or null)
siteName requiredstring (or null)
displayName requiredstring
givenName requiredstring (or null)
surname requiredstring (or null)
jobTitle requiredstring (or null)
department requiredstring (or null)
startDate requiredstring (date) (or null)
createAccount requiredboolean
userPrincipalName requiredstring (or null)
usageLocation requiredstring (or null)
managerUpn requiredstring (or null)
licenses requiredarray of NewHireNamed
groups requiredarray of NewHireNamed
deviceMode required"none" | "new" | "existing"
serialNumber requiredstring (or null)
deviceId requiredstring (uuid) (or null)
deviceHostname requiredstring (or null)
blueprintId requiredstring (uuid) (or null)
blueprintName requiredstring (or null)
shipTo requiredstring (or null)
carrier requiredstring (or null)
trackingNumber requiredstring (or null)
trackingUrl requiredstring (or null)
shippedAt requiredstring (date-time) (or null)
note requiredstring (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 requiredarray of NewHireStep
lastError requiredstring (or null)
passwordAvailable requiredboolean
passwordViewedAt requiredstring (date-time) (or null)
createdAt requiredstring (date-time)
createdBy requiredstring (or null)
readyAt requiredstring (date-time) (or null)
cancelledAt requiredstring (date-time) (or null)

OnboardingEndpointsCheckView #

FieldType
ordinal requiredinteger (int32)
kind required"windows_update" | "check" | "recovery_key_escrowed" | "admin_password_escrowed" | "restart_owed"
name requiredstring
state required"pending" | "running" | "passed" | "failed" | "skipped"
attempts requiredinteger (int32)
round requiredinteger (int32)
rounds requiredinteger (int32)
stage requiredstring (or null)
detail requiredstring (or null)
nextAttemptAt requiredstring (date-time) (or null)
startedAt requiredstring (date-time) (or null)
finishedAt requiredstring (date-time) (or null)
commandId requiredstring (uuid) (or null)
skippedBy requiredstring (uuid) (or null)
skipReason requiredstring (or null)

OnboardingEndpointsStepView #

FieldType
ordinal requiredinteger (int32)
itemKey requiredstring
kind requiredstring
name requiredstring
dependsOn requiredarray of integer (int32)
state required"pending" | "running" | "waiting_for_connector" | "succeeded" | "failed" | "blocked" | "skipped"
attempts requiredinteger (int32)
lastError requiredstring (or null)
nextAttemptAt requiredstring (date-time) (or null)
startedAt requiredstring (date-time) (or null)
finishedAt requiredstring (date-time) (or null)
commandId requiredstring (uuid) (or null)
skippedBy requiredstring (uuid) (or null)
continueOnFailure requiredboolean
retriedBy requiredstring (uuid) (or null)
retriedAt requiredstring (date-time) (or null)
answer required"ok" | "yes" | "no" (or null)
answeredByUser requiredboolean (or null)
onlyIfOrdinal requiredinteger (int32) (or null)
onlyIfAnswer required"yes" | "no" (or null)
tries requiredarray of TryView
signInsobject (or null) or SignInsView

OnlyIf #

FieldType
step requiredstring
answer requiredstring

OsPatchReport #

FieldType
generatedAt requiredstring (date-time)
clients requiredarray of ClientPatchReport
devices requiredarray of DevicePatchReport
truncated requiredboolean

OsPatchView #

FieldType
id requiredstring (uuid)
platform required"windows" | "macos"
vendorId requiredstring
kb requiredstring
kind requiredstring
title requiredstring
classification requiredstring
severity requiredstring
cves requiredarray of string
rebootRequired requiredboolean
preview requiredboolean
outOfBand requiredboolean
publisher requiredstring
releasedAt requiredstring (date-time) (or null)
risk required"low" | "standard" | "high"
riskReason requiredstring
decision requiredstring
decisionNote requiredstring (or null)
decidedAt requiredstring (date-time) (or null)
approvals requiredinteger (int32)
approvedByMe requiredboolean
status required"auto" | "after_pilot" | "needs_approval" | "needs_second_approval" | "approved" | "declined" | "blocked"
devices requiredinteger (int32)
firstSeenAt requiredstring (date-time)
reportedBy requiredstring (or null)
exploitedCves requiredarray of string
ransomware requiredboolean
dueAt requiredstring (date-time)

PatchExceptionView #

FieldType
type required"exception" | "declined" | "blocked" | "pin"
kind required"os" | "app"
holdId requiredstring (uuid) (or null)
patchId requiredstring (uuid) (or null)
title requiredstring
reference requiredstring
clientId requiredstring (uuid) (or null)
clientName requiredstring (or null)
deviceId requiredstring (uuid) (or null)
hostname requiredstring (or null)
wholeApp requiredboolean
reason requiredstring
ownerId requiredstring (uuid) (or null)
ownerName requiredstring (or null)
createdBy requiredstring (or null)
createdAt requiredstring (date-time) (or null)
expiresAt requiredstring (date-time) (or null)
state required"active" | "ending_soon" | "no_end_date"

PatchExceptionsReport #

FieldType
generatedAt requiredstring (date-time)
truncated requiredboolean
exceptions requiredarray of PatchExceptionView
people requiredarray of NamedView

PlanView #

FieldType
platform requiredstring
steps requiredarray of BlueprintEndpointsStepView
checks requiredarray of BlueprintEndpointsCheckView

PreviewItem #

FieldType
key requiredstring
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 requiredstring
locked requiredboolean
source requiredItemSource
overrides requiredobject (or null) or ItemSource

PreviewView #

FieldType
baseVersion requiredinteger (int32) (or null)
items requiredarray of PreviewItem
plans requiredmap of array of BlueprintEndpointsStepView
problems requiredarray of Problem
checks requiredmap of array of BlueprintEndpointsCheckView

Problem #

FieldType
field requiredstring
message requiredstring

RegisterAllView #

FieldType
queued requiredinteger (int32)

RegistrySetting #

FieldType
key requiredstring
namestring (or null)
kindstring (or null)
stringValuestring (or null)
numberValueinteger (or null)
multiValuearray of string (or null)
wow64boolean (or null)
removeboolean (or null)

Report #

FieldType
generatedAt requiredstring (date-time)
users requiredarray of UserView
apiKeys requiredarray of AccessReviewKeyView

RingView #

FieldType
deviceId requiredstring (uuid)
hostname requiredstring
clientId requiredstring (uuid) (or null)
ring requiredstring
chosen requiredboolean

RoleView #

FieldType
role requiredstring
scope requiredstring

ScriptParameter #

FieldType
name requiredstring
value requiredstring

SecurityCheck #

FieldType
kind required"encryption" | "antivirus" | "firewall" | "patches" | "admins" | "boot" | "checkin"
title requiredstring
state required"pass" | "partial" | "fail" | "unknown" | "not_applicable"
weight requiredinteger (int32)
earned requiredinteger (int32)
detail requiredstring

SecurityCheckCount #

FieldType
kind required"encryption" | "antivirus" | "firewall" | "patches" | "admins" | "boot" | "checkin"
title requiredstring
failing requiredinteger (int32)
partial requiredinteger (int32)

SecurityFixOffer #

FieldType
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 requiredstring
detail requiredstring
passkey requiredboolean
username requiredstring (or null)
unavailable requiredstring (or null)

SecurityGuide #

FieldType
check required"encryption" | "antivirus" | "firewall" | "patches" | "admins" | "boot" | "checkin"
title requiredstring
steps requiredarray of string

SecurityReport #

FieldType
generatedAt requiredstring (date-time)
score requiredinteger (int32) (or null)
grade required"good" | "fair" | "at_risk" (or null)
devices requiredinteger (int32)
clients requiredarray of ClientSecurityLine
checks requiredarray of SecurityCheckCount
deviceLines requiredarray of DeviceSecurityLine
truncated requiredboolean

SelfServiceAppView #

FieldType
id requiredstring (uuid)
packageId requiredstring (uuid)
name requiredstring
platform requiredstring
publisher requiredstring
needsApproval requiredboolean
note requiredstring
addedAt requiredstring (date-time)
addedBy requiredstring (or null)
archived requiredboolean

SelfServiceRequestView #

FieldType
id requiredstring (uuid)
deviceId requiredstring (uuid)
hostname requiredstring
packageId requiredstring (uuid) (or null)
packageName requiredstring
requestedBy requiredstring
reason requiredstring
neededApproval requiredboolean
state requiredstring
createdAt requiredstring (date-time)
decidedAt requiredstring (date-time) (or null)
decidedBy requiredstring (or null)
decisionNote requiredstring
jobId requiredstring (uuid) (or null)

SelfServiceView #

FieldType
available requiredboolean
enabled requiredboolean
approverEmails requiredarray of string
apps requiredarray of SelfServiceAppView
requests requiredarray of SelfServiceRequestView
pending requiredinteger (int32)

ServiceSetting #

FieldType
name requiredstring
startupstring (or null)
statestring (or null)

SessionView #

FieldType
id requiredstring (uuid)
deviceId requiredstring (uuid)
blueprintId requiredstring (uuid)
blueprintName requiredstring
versionId requiredstring (uuid) (or null)
version requiredinteger (int32) (or null)
platform required"windows" | "macos"
state required"running" | "blocked" | "succeeded" | "failed" | "cancelled"
error requiredstring (or null)
startedBy requiredstring (uuid) (or null)
createdAt requiredstring (date-time)
updatedAt requiredstring (date-time)
finishedAt requiredstring (date-time) (or null)
steps requiredarray of OnboardingEndpointsStepView
phase required"steps" | "verifying"
checks requiredarray of OnboardingEndpointsCheckView
purpose required"onboarding" | "standard" | "addon" | "addon_check" | "user_apps"
status required"running" | "blocked" | "verifying" | "not_ready" | "succeeded" | "failed" | "cancelled"

SignInsView #

FieldType
installed requiredinteger (int32)
failed requiredinteger (int32)
running requiredinteger (int32)

StandardClientSummary #

FieldType
clientId requiredstring (uuid) (or null)
clientName requiredstring (or null)
enabled requiredboolean
devices requiredinteger (int32)
inStandard requiredinteger (int32)
fixed requiredinteger (int32)
failed requiredinteger (int32)
notChecked requiredinteger (int32)

StatusLinkCreated #

FieldType
link requiredStatusLinkView
url requiredstring
FieldType
links requiredarray of StatusLinkView
available requiredboolean

StatusLinkView #

FieldType
id requiredstring (uuid)
clientId requiredstring (uuid)
label requiredstring
state requiredstring
createdAt requiredstring (date-time)
createdBy requiredstring (or null)
expiresAt requiredstring (date-time) (or null)
revokedAt requiredstring (date-time) (or null)
lastViewedAt requiredstring (date-time) (or null)
views requiredinteger (int32)
revokedForPlan requiredboolean

TagCount #

FieldType
tag requiredstring
devices requiredinteger (int32)

TeamEndpointsMemberView #

FieldType
id requiredstring (uuid)
email requiredstring
displayName requiredstring
disabled requiredboolean
grants requiredarray of GrantView
recoveryLocked requiredboolean
ssoLinked requiredboolean
hasPasskey requiredboolean
hasRecovery requiredboolean

TryView #

FieldType
commandId requiredstring (uuid)
state requiredstring
exitCode requiredinteger (int32) (or null)
startedAt requiredstring (date-time) (or null)
finishedAt requiredstring (date-time) (or null)
error requiredstring

UserView #

FieldType
id requiredstring (uuid)
email requiredstring
displayName requiredstring
status requiredstring
roles requiredarray of RoleView
passkeys requiredinteger (int32)
deviceBoundPasskeys requiredinteger (int32)
ssoLinked requiredboolean
mfa requiredstring
createdAt requiredstring (date-time)
disabledAt requiredstring (date-time) (or null)
lastSignInAt requiredstring (date-time) (or null)
lastActiveAt requiredstring (date-time) (or null)
stale requiredboolean

VersionDetailView #

FieldType
version requiredBlueprintEndpointsVersionView
document requiredBlueprintDocument
items requiredarray of PreviewItem
checks requiredarray of BlueprintItem

WakeAdapterView #

FieldType
name requiredstring
macAddress requiredstring
kind required"wired" | "wireless" | "other"
up requiredboolean
ipv4 requiredarray of string

WakeRelayView #

FieldType
deviceId requiredstring (uuid)
hostname requiredstring

WakeView #

FieldType
canWake requiredboolean
reason required"online" | "retired" | "agent_too_old" | "no_mac" | "no_network" | "no_relay" (or null)
message requiredstring (or null)
adapters requiredarray of WakeAdapterView
relays requiredarray of WakeRelayView

WarrantyView #

FieldType
deviceId requiredstring (uuid)
vendor requiredstring
looksUp requiredboolean
source requiredstring (or null)
lookupState requiredstring (or null)
startDate requiredstring (date) (or null)
endDate requiredstring (date) (or null)
shipDate requiredstring (date) (or null)
purchaseDate requiredstring (date) (or null)
description requiredstring (or null)
state requiredstring
daysLeft requiredinteger (int32) (or null)
checkedAt requiredstring (date-time) (or null)
nextCheckAt requiredstring (date-time) (or null)
lastError requiredstring (or null)
ageFromDate requiredstring (date)
ageFrom requiredstring
ageYears requirednumber (double)
refreshDue requiredstring (date)
bucket requiredstring

Last updated 2026-11-14. Something wrong or missing? Email [email protected].