https://breeze.yourdomain.com/api/v1
All API requests (except enrollment, health, SSO, and portal) require a JWT bearer token:
curl -H " Authorization: Bearer $TOKEN " \
https://breeze.yourdomain.com/api/v1/devices
API keys can also be used via the X-API-Key header:
curl -H " X-API-Key: brz_... " \
https://breeze.yourdomain.com/api/v1/devices
curl -X POST https://breeze.yourdomain.com/api/v1/auth/login \
-H " Content-Type: application/json " \
-d ' {"email": "admin@example.com", "password": "..."} '
# { "accessToken": "eyJ...", "refreshToken": "..." }
curl -X POST https://breeze.yourdomain.com/api/v1/auth/refresh \
-H " Content-Type: application/json " \
-d ' {"refreshToken": "..."} '
Method Path Description GET/devicesList devices (paginated, filterable; supports keyset cursor) GET/devices/:idGet device details POST/devices/provisionPre-create a device row before any agent has enrolled. Returns a single-use enrollment payload. POST/devices/:id/move-orgRelocate a device to a different organization within the same partner. POST/devices/:id/commandsSend command to device. Rejects a duplicate refresh_inventory with 409 ALREADY_PENDING. POST/devices/bulk/commandsSend the same command to many devices. Returns commands, skipped, and failed arrays. DELETE/devices/:idDecommission device
GET /devices supports a cursor-based paging mode in addition to the legacy page/limit shape. Pass cursor, sort (hostname / lastSeen / enrolled), sortDir, limit (max 1000), and optional filters like orgIds, siteIds, groupIds, includeDecommissioned, and includeTotal. The response carries { devices, nextCursor, limit, total? }; pass nextCursor back as cursor to fetch the next page. The list payload also exposes mainAgentSilentSince and watchdogStatus per device so callers can render the Agent silent (watchdog OK) badge described in Agent Watchdog .
Method Path Description GET/orgs/List orgs in scope GET/orgs/partnersList all partners (system scope) POST/orgs/partnersCreate partner GET/orgs/partners/:idGet partner details PATCH/orgs/partners/:idUpdate partner DELETE/orgs/partners/:idDelete partner GET/orgs/partners/meGet current partner PATCH/orgs/partners/meUpdate partner settings GET/orgs/organizationsList organizations POST/orgs/organizationsCreate organization GET/orgs/organizations/:idGet organization PATCH/orgs/organizations/:idUpdate organization DELETE/orgs/organizations/:idDelete organization
Method Path Description GET/orgs/sitesList sites POST/orgs/sitesCreate site GET/orgs/sites/:idGet site details PATCH/orgs/sites/:idUpdate site DELETE/orgs/sites/:idDelete site
Method Path Description GET/groupsList groups GET/groups/:idGet group details POST/groupsCreate group (static or dynamic) PATCH/groups/:idUpdate group DELETE/groups/:idDelete group GET/groups/:id/devicesList devices in group POST/groups/:id/devicesAdd devices to group DELETE/groups/:id/devices/:deviceIdRemove device from group POST/groups/:id/previewPreview dynamic group membership POST/groups/:id/devices/:deviceId/pinPin device to dynamic group DELETE/groups/:id/devices/:deviceId/pinUnpin device GET/groups/:id/membership-logGroup membership change log
Method Path Description GET/tagsList all tags GET/tags/devicesList device tags
Method Path Description GET/users/meGet current user profile PATCH/users/meUpdate current user profile GET/usersList users GET/users/rolesList users with roles GET/users/:idGet user POST/users/inviteInvite user POST/users/resend-inviteResend invitation PATCH/users/:idUpdate user DELETE/users/:idDelete user POST/users/:id/roleAssign user role
Method Path Description GET/rolesList roles POST/rolesCreate role GET/roles/:idGet role PATCH/roles/:idUpdate role DELETE/roles/:idDelete role POST/roles/:id/cloneClone role GET/roles/:id/usersList users with role GET/roles/:id/effective-permissionsGet effective permissions GET/roles/permissions/availableList available permissions
Method Path Description GET/access-reviewsList access reviews POST/access-reviewsCreate access review GET/access-reviews/:idGet review details PATCH/access-reviews/:id/items/:itemIdUpdate review item POST/access-reviews/:id/completeComplete review
Method Path Description GET/api-keysList API keys POST/api-keysCreate API key GET/api-keys/:idGet API key PATCH/api-keys/:idUpdate API key DELETE/api-keys/:idRevoke API key POST/api-keys/:id/rotateRotate API key
Method Path Description GET/alertsList alerts GET/alerts/summaryAlert summary counts GET/alerts/:idGet alert details POST/alerts/:id/acknowledgeAcknowledge alert POST/alerts/:id/resolveResolve alert POST/alerts/:id/suppressSuppress alert
Method Path Description GET/alerts/rulesList alert rules GET/alerts/rules/:idGet alert rule POST/alerts/rulesCreate alert rule PATCH/alerts/rules/:idUpdate alert rule DELETE/alerts/rules/:idDelete alert rule POST/alerts/rules/:id/testTest alert rule
Method Path Description GET/alerts/channelsList notification channels POST/alerts/channelsCreate channel (email, Slack, Teams, webhook, PagerDuty, SMS) PATCH/alerts/channels/:idUpdate channel DELETE/alerts/channels/:idDelete channel POST/alerts/channels/:id/testTest channel
Method Path Description GET/alerts/policiesList alert policies POST/alerts/policiesCreate policy PATCH/alerts/policies/:idUpdate policy DELETE/alerts/policies/:idDelete policy
Method Path Description GET/alert-templates/templatesList templates GET/alert-templates/templates/built-inList built-in templates POST/alert-templates/templatesCreate template PATCH/alert-templates/templates/:idUpdate template DELETE/alert-templates/templates/:idDelete template GET/alert-templates/correlationsList correlation rules GET/alert-templates/correlations/groupsGet correlation groups POST/alert-templates/correlations/analyzeAnalyze correlations
Method Path Description GET/scriptsList scripts GET/scripts/system-libraryList system library scripts POST/scripts/import/:idImport script from library GET/scripts/:idGet script POST/scriptsCreate script PUT/scripts/:idUpdate script DELETE/scripts/:idDelete script POST/scripts/:id/executeExecute on device(s) GET/scripts/:id/executionsList executions GET/scripts/executions/:idGet execution details POST/scripts/executions/:id/cancelCancel execution
Method Path Description GET/script-library/categoriesList categories POST/script-library/categoriesCreate category GET/script-library/categories/:idGet category PATCH/script-library/categories/:idUpdate category DELETE/script-library/categories/:idDelete category GET/script-library/tagsList script tags POST/script-library/tagsCreate tag DELETE/script-library/tags/:idDelete tag GET/script-library/scripts/:id/versionsList script versions POST/script-library/scripts/:id/versionsCreate new version POST/script-library/scripts/:id/rollback/:versionIdRollback to version GET/script-library/templatesList templates POST/script-library/from-template/:templateIdCreate script from template GET/script-library/scripts/:id/usage-statsScript usage statistics
Method Path Description GET/automationsList automations GET/automations/runs/:runIdGet automation run GET/automations/:idGet automation POST/automationsCreate automation PATCH/automations/:idUpdate automation DELETE/automations/:idDelete automation POST/automations/:id/triggerTrigger automation POST/automations/:id/runRun automation immediately GET/automations/:id/runsList runs for automation
Method Path Description GET/patchesList patches POST/patches/scanTrigger patch scan GET/patches/sourcesList patch sources GET/patches/approvalsList pending approvals POST/patches/bulk-approveBulk approve patches GET/patches/jobsList patch jobs GET/patches/complianceCompliance overview GET/patches/compliance/reportList compliance reports GET/patches/compliance/report/:idGet compliance report GET/patches/compliance/report/:id/downloadDownload report POST/patches/:id/rollbackRollback a patch POST/patches/:id/approveApprove patch POST/patches/:id/declineDecline patch POST/patches/:id/deferDefer patch GET/patches/:idGet patch details
GET /patches accepts ?source= (microsoft, apple, linux, third_party, custom) and returns source on every patch. Third-party patches also carry version, vendor, and a cveIds array populated by OSV.dev enrichment.
Platform-admin scope. Backs the third-party application patching catalog and AI smoke tests — see Patch Management .
Method Path Description GET/third-party-catalogList catalog entries (?vendor=&breezeTested=&search=) POST/third-party-catalogCreate a catalog entry GET/third-party-catalog/:idGet a catalog entry PATCH/third-party-catalog/:idUpdate a catalog entry DELETE/third-party-catalog/:idDelete a catalog entry POST/third-party-catalog/:id/testQueue a smoke test ({ "version": "..." })
Method Path Description GET/patch-policiesList patch policies POST/patch-policiesCreate policy GET/patch-policies/:idGet policy PATCH/patch-policies/:idUpdate policy DELETE/patch-policies/:idDelete policy
Method Path Description GET/security/statusOrg security status overview GET/security/status/:deviceIdDevice security status GET/security/threatsList threats across org GET/security/threats/:deviceIdList threats for device POST/security/threats/:id/quarantineQuarantine threat POST/security/threats/:id/removeRemove threat POST/security/threats/:id/restoreRestore quarantined file POST/security/scan/:deviceIdTrigger security scan GET/security/scans/:deviceIdList scan history GET/security/policiesList security policies POST/security/policiesCreate security policy PUT/security/policies/:idUpdate security policy GET/security/dashboardSecurity dashboard data GET/security/score-breakdownSecurity score breakdown GET/security/postureOrg security posture GET/security/posture/:deviceIdDevice security posture GET/security/trendsSecurity trends over time GET/security/firewallFirewall status across org GET/security/encryptionEncryption status across org GET/security/password-policyPassword policy compliance GET/security/admin-auditAdmin action audit GET/security/recommendationsSecurity recommendations POST/security/recommendations/:id/completeMark recommendation complete POST/security/recommendations/:id/dismissDismiss recommendation
Method Path Description GET/software/catalogList software catalog POST/software/catalogAdd to catalog GET/software/catalog/searchSearch catalog GET/software/catalog/:id/versionsList versions POST/software/catalog/:id/versionsAdd version GET/software/catalog/:idGet software details PATCH/software/catalog/:idUpdate software DELETE/software/catalog/:idRemove from catalog GET/software/deploymentsList deployments POST/software/deploymentsCreate deployment GET/software/deployments/:idGet deployment POST/software/deployments/:id/cancelCancel deployment GET/software/deployments/:id/resultsGet results GET/software/inventoryFull software inventory GET/software/inventory/:deviceIdDevice software POST/software/inventory/:deviceId/:softwareId/uninstallUninstall software
Method Path Description GET/monitorsList monitors POST/monitorsCreate monitor GET/monitors/dashboardMonitor dashboard GET/monitors/:idGet monitor PATCH/monitors/:idUpdate monitor DELETE/monitors/:idDelete monitor POST/monitors/:id/checkRun check now POST/monitors/:id/testTest monitor config GET/monitors/:id/resultsCheck result history GET/monitors/alertsList monitor alerts GET/monitors/:monitorId/alertsMonitor-specific alerts PATCH/monitors/alerts/:idUpdate monitor alert DELETE/monitors/alerts/:idDelete monitor alert
Method Path Description GET/discovery/profilesList scan profiles POST/discovery/profilesCreate profile GET/discovery/profiles/:idGet profile PATCH/discovery/profiles/:idUpdate profile DELETE/discovery/profiles/:idDelete profile POST/discovery/scanStart discovery scan GET/discovery/jobsList scan jobs GET/discovery/jobs/:idGet job status POST/discovery/jobs/:id/cancelCancel scan GET/discovery/assetsList discovered assets POST/discovery/assets/:id/linkLink asset to device POST/discovery/assets/:id/ignoreIgnore asset DELETE/discovery/assets/:idDelete asset POST/discovery/assets/:id/enable-monitoringEnable monitoring POST/discovery/assets/:id/disable-monitoringDisable monitoring GET/discovery/assets/:id/monitoringGet monitoring config PATCH/discovery/assets/:id/monitoringUpdate monitoring config GET/discovery/topologyNetwork topology map
Method Path Description GET/snmp/devicesList SNMP devices POST/snmp/devicesAdd SNMP device GET/snmp/devices/:idGet device PATCH/snmp/devices/:idUpdate device DELETE/snmp/devices/:idDelete device POST/snmp/devices/:id/pollPoll device now POST/snmp/devices/:id/testTest SNMP connectivity GET/snmp/templatesList SNMP templates POST/snmp/templatesCreate template GET/snmp/templates/:idGet template PATCH/snmp/templates/:idUpdate template DELETE/snmp/templates/:idDelete template GET/snmp/oids/browseBrowse OID tree POST/snmp/oids/validateValidate OIDs GET/snmp/metrics/:deviceIdGet device metrics GET/snmp/metrics/:deviceId/historyMetrics history GET/snmp/metrics/:deviceId/:oidGet specific OID metric GET/snmp/thresholds/:deviceIdList thresholds POST/snmp/thresholdsCreate threshold PATCH/snmp/thresholds/:idUpdate threshold DELETE/snmp/thresholds/:idDelete threshold GET/snmp/dashboardSNMP dashboard
Method Path Description DELETE/remote/sessions/staleClean stale sessions GET/remote/sessionsList active sessions POST/remote/sessionsCreate remote session GET/remote/sessions/historySession history GET/remote/sessions/:idGet session POST/remote/sessions/:id/ws-ticketGet WebSocket ticket POST/remote/sessions/:id/desktop-connect-codeGet desktop connect code GET/remote/ice-serversGet ICE/TURN server config POST/remote/sessions/:id/offerWebRTC SDP offer POST/remote/sessions/:id/answerWebRTC SDP answer POST/remote/sessions/:id/iceICE candidate exchange POST/remote/sessions/:id/endEnd session
Method Path Description GET/remote/transfersList transfers POST/remote/transfersInitiate transfer GET/remote/transfers/:idGet transfer status POST/remote/transfers/:id/cancelCancel transfer POST/remote/transfers/:id/chunksUpload chunk GET/remote/transfers/:id/downloadDownload file GET/remote/transfers/:id/progressTransfer progress
Device-scoped management commands exposed as REST endpoints.
Method Path Description GET/system-tools/devices/:deviceId/processesList processes GET/system-tools/devices/:deviceId/processes/:pidGet process details POST/system-tools/devices/:deviceId/processes/:pid/killKill process GET/system-tools/devices/:deviceId/servicesList services GET/system-tools/devices/:deviceId/services/:nameGet service POST/system-tools/devices/:deviceId/services/:name/startStart service POST/system-tools/devices/:deviceId/services/:name/stopStop service POST/system-tools/devices/:deviceId/services/:name/restartRestart service GET/system-tools/devices/:deviceId/registry/keysList registry keys GET/system-tools/devices/:deviceId/registry/valuesList registry values GET/system-tools/devices/:deviceId/registry/valueGet registry value PUT/system-tools/devices/:deviceId/registry/valueSet registry value DELETE/system-tools/devices/:deviceId/registry/valueDelete registry value POST/system-tools/devices/:deviceId/registry/keyCreate registry key DELETE/system-tools/devices/:deviceId/registry/keyDelete registry key GET/system-tools/devices/:deviceId/eventlogsList event logs GET/system-tools/devices/:deviceId/eventlogs/:nameGet event log GET/system-tools/devices/:deviceId/eventlogs/:name/eventsQuery events GET/system-tools/devices/:deviceId/eventlogs/:name/events/:recordIdGet event GET/system-tools/devices/:deviceId/tasksList scheduled tasks GET/system-tools/devices/:deviceId/tasks/:pathGet task GET/system-tools/devices/:deviceId/tasks/:path/historyTask history POST/system-tools/devices/:deviceId/tasks/:path/runRun task POST/system-tools/devices/:deviceId/tasks/:path/enableEnable task POST/system-tools/devices/:deviceId/tasks/:path/disableDisable task GET/system-tools/devices/:deviceId/filesList/read files GET/system-tools/devices/:deviceId/files/downloadDownload file POST/system-tools/devices/:deviceId/files/uploadUpload file
Method Path Description GET/maintenance/windowsList maintenance windows POST/maintenance/windowsCreate window GET/maintenance/windows/:idGet window PATCH/maintenance/windows/:idUpdate window DELETE/maintenance/windows/:idDelete window POST/maintenance/windows/:id/cancelCancel window GET/maintenance/windows/:id/occurrencesList occurrences GET/maintenance/occurrencesList all occurrences GET/maintenance/occurrences/:idGet occurrence POST/maintenance/occurrences/:id/startStart manually POST/maintenance/occurrences/:id/endEnd manually GET/maintenance/activeList currently active windows
Method Path Description GET/policiesList policies GET/policies/compliance/statsCompliance statistics GET/policies/compliance/summaryCompliance summary GET/policies/:idGet policy POST/policiesCreate policy PUT/policies/:idReplace policy PATCH/policies/:idUpdate policy DELETE/policies/:idDelete policy POST/policies/:id/activateActivate policy POST/policies/:id/deactivateDeactivate policy POST/policies/:id/evaluateEvaluate policy GET/policies/:id/compliancePolicy compliance details POST/policies/:id/remediateRemediate non-compliant devices
Method Path Description GET/deploymentsList deployments POST/deploymentsCreate deployment GET/deployments/:idGet deployment PATCH/deployments/:idUpdate deployment DELETE/deployments/:idDelete deployment POST/deployments/:id/initializeInitialize deployment POST/deployments/:id/startStart deployment POST/deployments/:id/pausePause deployment POST/deployments/:id/resumeResume deployment POST/deployments/:id/cancelCancel deployment GET/deployments/:id/devicesList deployment devices POST/deployments/:id/devices/:deviceId/retryRetry failed device
Method Path Description GET/reportsList report definitions GET/reports/:idGet report definition POST/reportsCreate report definition PUT/reports/:idUpdate report DELETE/reports/:idDelete report POST/reports/:id/generateGenerate report POST/reports/generateGenerate ad-hoc report GET/reports/runsList report runs GET/reports/runs/:idGet report run GET/reports/data/device-inventoryDevice inventory data GET/reports/data/software-inventorySoftware inventory data GET/reports/data/alerts-summaryAlerts summary data GET/reports/data/complianceCompliance data GET/reports/data/metricsMetrics data
Method Path Description POST/analytics/queryRun analytics query GET/analytics/dashboardsList dashboards POST/analytics/dashboardsCreate dashboard GET/analytics/dashboards/:idGet dashboard PATCH/analytics/dashboards/:idUpdate dashboard DELETE/analytics/dashboards/:idDelete dashboard POST/analytics/dashboards/:id/widgetsAdd widget PATCH/analytics/widgets/:idUpdate widget DELETE/analytics/widgets/:idDelete widget GET/analytics/capacityCapacity planning data GET/analytics/slaSLA compliance overview POST/analytics/slaCreate SLA GET/analytics/sla/:id/complianceSLA compliance details GET/analytics/executive-summaryExecutive summary GET/analytics/os-distributionOS distribution
Method Path Description GET/auditList audit events GET/audit/logsList audit logs (paginated) GET/audit/logs/:idGet log entry GET/audit/searchSearch audit logs GET/audit/exportExport as CSV/JSON POST/audit/exportExport with filters GET/audit/reports/user-activityUser activity report GET/audit/reports/security-eventsSecurity events report GET/audit/reports/complianceCompliance report GET/audit/statsAudit statistics
Method Path Description GET/notificationsList notifications GET/notifications/unread-countUnread count PATCH/notifications/:idMark as read DELETE/notifications/:idDelete notification DELETE/notificationsClear all notifications
Method Path Description GET/webhooksList webhooks POST/webhooksCreate webhook GET/webhooks/:idGet webhook PATCH/webhooks/:idUpdate webhook DELETE/webhooks/:idDelete webhook GET/webhooks/:id/deliveriesDelivery log POST/webhooks/:id/testTest webhook POST/webhooks/:id/retry/:deliveryIdRetry delivery
Method Path Description GET/plugins/catalogList available plugins GET/plugins/catalog/:slugGet plugin details GET/plugins/installationsList installations POST/plugins/installationsInstall plugin GET/plugins/installations/:idGet installation PATCH/plugins/installations/:idUpdate config DELETE/plugins/installations/:idUninstall POST/plugins/installations/:id/enableEnable POST/plugins/installations/:id/disableDisable GET/plugins/installations/:id/logsPlugin logs
Method Path Description GET/custom-fieldsList custom fields GET/custom-fields/:idGet field POST/custom-fieldsCreate field PATCH/custom-fields/:idUpdate field DELETE/custom-fields/:idDelete field
Method Path Description POST/filters/previewPreview filter results GET/filtersList saved filters POST/filtersCreate filter GET/filters/:idGet filter PATCH/filters/:idUpdate filter DELETE/filters/:idDelete filter POST/filters/:id/previewPreview saved filter
Method Path Description GET/psa/connectionsList PSA connections POST/psa/connectionsCreate connection GET/psa/connections/:idGet connection PATCH/psa/connections/:idUpdate connection DELETE/psa/connections/:idDelete connection POST/psa/connections/:id/testTest connection POST/psa/connections/:id/syncTrigger sync GET/psa/connections/:id/statusSync status GET/psa/ticketsList tickets GET/psa/connections/:id/ticketsTickets for connection
Method Path Auth Description GET/sso/presetsJWT List SSO presets GET/sso/providersJWT List SSO providers GET/sso/providers/:idJWT Get provider POST/sso/providersJWT Create provider PATCH/sso/providers/:idJWT Update provider DELETE/sso/providers/:idJWT Delete provider GET/sso/login/:orgIdNone Initiate SSO login GET/sso/callbackNone SSO callback POST/sso/exchangeNone Token exchange GET/sso/check/:orgIdNone Check SSO availability
Method Path Description GET/enrollment-keysList enrollment keys POST/enrollment-keysCreate enrollment key DELETE/enrollment-keys/:idDelete enrollment key POST/enrollment-keys/:id/rotateRotate key GET/enrollment-keys/:idGet key details
Method Path Auth Description POST/agents/enrollEnrollment secret Enroll new device GET/agents/download/:os/:archNone Download agent binary GET/agents/install.shNone One-line install script
Method Path Description GET/agent-versions/latestGet latest agent version GET/agent-versions/:version/downloadDownload specific version GET/agent-versionsList all versions
Method Path Description POST/ai/sessionsCreate chat session GET/ai/sessionsList sessions GET/ai/sessions/searchSearch sessions GET/ai/sessions/:idGet session DELETE/ai/sessions/:idDelete session POST/ai/sessions/:id/messagesSend message (streaming) POST/ai/sessions/:id/interruptInterrupt response POST/ai/sessions/:id/approve/:executionIdApprove tool execution GET/ai/usageAI usage stats GET/ai/budgetAI budget info GET/ai/admin/sessionsAdmin: list all sessions GET/ai/admin/security-eventsAdmin: security events
Method Path Auth Description GET/mcp/sseAPI key SSE transport for MCP POST/mcp/messageAPI key Send MCP message
Method Path Description POST/mobile/notifications/registerRegister push token POST/mobile/notifications/unregisterUnregister push token GET/mobile/devicesList devices (mobile-optimized) GET/mobile/devices/:id/settingsDevice settings GET/mobile/devices/:idDevice details GET/mobile/alerts/inboxAlert inbox POST/mobile/alerts/:id/acknowledgeAcknowledge alert POST/mobile/alerts/:id/resolveResolve alert POST/mobile/devices/:id/actionsSend device action GET/mobile/summaryDashboard summary
Method Path Auth Description GET/portal/branding/:domainNone Get portal branding GET/portal/brandingNone Default branding POST/portal/auth/loginNone Portal login POST/portal/auth/forgot-passwordNone Forgot password POST/portal/auth/reset-passwordNone Reset password POST/portal/auth/logoutPortal session Logout GET/portal/devicesPortal session List devices GET/portal/ticketsPortal session List tickets POST/portal/ticketsPortal session Create ticket GET/portal/tickets/:idPortal session Get ticket POST/portal/tickets/:id/commentsPortal session Add comment GET/portal/assetsPortal session List assets POST/portal/assets/:id/checkoutPortal session Check out asset POST/portal/assets/:id/checkinPortal session Check in asset GET/portal/profilePortal session Get profile PATCH/portal/profilePortal session Update profile POST/portal/profile/passwordPortal session Change password
Method Path Description GET/partner/dashboardPartner dashboard data
Method Path Description GET/searchGlobal search across devices, users, orgs, scripts, alerts
List endpoints support cursor-based pagination:
curl " https://breeze.yourdomain.com/api/v1/devices?limit=50&cursor=eyJ... "
GET /devices accepts a limit of up to 500 per page (default 50) so partners can pull large fleets in fewer round trips; other list endpoints keep the standard default of 100. The dashboard’s devices list has its own per-page selector (10–200).
Response:
All errors follow a consistent format:
"code" : " VALIDATION_ERROR " ,
"message" : " Invalid email address " ,
