Skip to content
OTA-Pulse Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting Started
Getting Started
Install the OTA-Pulse Agent
Register your first device
Ship your first update
Concepts
Concepts
Device Lifecycle
Deployments
Artifacts
Roles and Access Control
Device Integration
Device Integration
Yocto integration
API Reference
Overview
Operations
Root
Health
Admin
List All Api Keys
Delete Api Key
Revoke Api Key
Delete Inactive Devices
Revoke Expired Keys
List All Devices
Bulk Delete Devices
Delete Device
List All Organizations
Delete Organization
Get Admin Stats
List All Users
Get User Detail
Delete User
Make Superuser
Revoke Superuser
Toggle User Active
API Keys
List Api Keys
Create Api Key
Get Api Key
Revoke Api Key
Rotate Api Key
Authentication
Login
Logout
Get Current User Info
Change Password
Request Password Reset
Confirm Password Reset
Refresh Token
Register
Coredumps
List Coredumps
List Crash Groups
Update Crash Group
Get Crash Statistics
Get Coredump
Delete Coredump
Get Coredump Analysis
Analyze Coredump
Download Coredump
Deployments
List All Deployments
Cancel Deployment
Get Deployment Logs
Pause Deployment
Resume Deployment
Retry Deployment
Rollback Deployment
Devices
List Devices
Create Device
Bulk Delete Devices
Get Device Summary
Get Device
Delete Device
Update Device
Activate Device
Deactivate Device
Get Device Metrics
Mender-Compatible OTA API
Mender Auth Request
Mender Check Update V1 Get
Mender Check Update V1
Mender Upload Log
Mender Upload Log
Mender Update Status
Mender Download Artifact
Mender Update Inventory
Mender Update Inventory
Mender Check Update V2
Mender Get Control Map
Firmware/OTA
List Firmware
Create Firmware
Check Artifact Tool
Preview Artifact Metadata
Get Firmware
Delete Firmware
Update Firmware
Create Mender Artifact
Deploy Firmware
List Deployments
Get Deployment Stats
Upload Firmware File
Upload Mender Artifact
Health
Health Check
Liveness Check
Readiness Check
Metrics
Cleanup Old Metrics
Get Device Metrics
Get Device Metrics Summary
Get Device Metric Timeseries
List Metric Names
Get Storage Stats
Get Fleet Summary
OAuth2 SSO
Oauth Authorize
Oauth Complete
Oauth Token
Oauth Userinfo
Organizations
List Organizations
Create Organization
Get Organization
Delete Organization
Update Organization
List Members
Add Member
Remove Member
Update Member
Provisioning Tokens
List Provisioning Tokens
Create Provisioning Token
Get Provisioning Token
Revoke Provisioning Token
Rotate Provisioning Token
Signing Keys
List active signing keys for organisation
Generate a new signing key pair
Revoke a signing key (org owner only)
Users
List Users
Get Current User Profile
Update Current User Profile
Get User
Delete User
Update User
Device API
Upload Coredump
Device Heartbeat
Ingest Metrics
Check Ota Update
Download Ota Update
Update Ota Status
Provision Device
Register Device
Troubleshooting
Troubleshooting
Agent registers but never appears in the console
signature verification failed with all loaded keys
GLIBC_2.38 not found
no space left on device
GitHub
Select theme
Dark
Light
Auto
Logout
POST
/api/auth/logout
Logout and revoke all refresh tokens
Authorizations
HTTPBearer
Responses
200
Successful Response
Select media type
application/json
