Skip to content
OTA-Pulse Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Platform Support
Platform support
Getting Started
Getting Started
Install the OTA-Pulse Agent
Register your first device
Ship your first update
Pricing & Plan Limits
Concepts
Concepts
Device Lifecycle
Deployments
Artifacts
Roles and Access Control
Device Integration
Device Integration
Yocto integration
Linux — Buildroot
MCU — ESP32 (ESP-IDF)
MCU — Zephyr (Nordic / STM32)
Remote SSH
Overview
Security Model
Operator How-To
Admin Guide
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
Shell Audit
Query shell audit events
Query shell audit events
Export shell audit events as CSV or JSON
Export shell audit events as CSV or JSON
Google Sign-In
Google Callback
Google Login
Authentication
Login
Logout
Get Current User Info
Change Password
Request Password Reset
Confirm Password Reset
Refresh Token
Register
Verify Email
Resend Verification Email
MCU Federation
Mcu Jwks
Mint Mcu Access Token
MFA
Regenerate Backup Codes
Challenge
Disable
Enroll
Enroll Confirm
Mfa Status
Billing
Cancel Subscription
Checkout
Get Billing Config
Validate Coupon Code
Create Stripe Setup Intent
Get Subscription
Billing Webhooks
Stripe webhook receiver (unauthenticated; signature is the auth)
Client Errors
Report Client Error
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
Get tunnel credential metadata
Rotate tunnel credential
Device OTA API
Device authentication
Check for next deployment (v1, GET)
Check for next deployment (v1)
Upload deployment log
Upload deployment log
Report deployment status
Download deployment artifact
Submit device inventory
Update device inventory
Check for next deployment (v2)
Get update control map
Shell Sessions
List shell sessions for a device
List shell sessions for a device
Open a Standard, Elevated, or Break-Glass shell session
Open a Standard, Elevated, or Break-Glass shell session
List all shell sessions for an organisation
List all shell sessions for an organisation
List pending approval requests for the calling user's org (inbox)
List pending approval requests for the calling user's org (inbox)
Get a shell session record
Get a shell session record
Force-terminate an active or pending shell session (TASK-S20-004)
Force-terminate an active or pending shell session (TASK-S20-004)
Approve a pending shell session (peer approval)
Approve a pending shell session (peer approval)
Deny a pending shell session (peer approval)
Deny a pending shell session (peer approval)
Get a presigned download URL for a session recording
Get a presigned download URL for a session recording
Recording immutability gate — DELETE is not permitted (RSSH-304)
Recording immutability gate — DELETE is not permitted (RSSH-304)
Export a session recording (presigned URL, compliance / bulk-export gate)
Export a session recording (presigned URL, compliance / bulk-export gate)
Get the S3 object-lock retention state of a session recording (F15 / S22-004)
Get the S3 object-lock retention state of a session recording (F15 / S22-004)
Mint a WS terminal token for an active session (post-approval)
Mint a WS terminal token for an active session (post-approval)
Mint a short-lived resume token to reconnect to a live session (TASK-S21-003)
Mint a short-lived resume token to reconnect to a live session (TASK-S21-003)
Firmware/OTA
List Firmware
Create Firmware
Check Artifact Tool
Preview Artifact Metadata
Get Firmware
Delete Firmware
Update Firmware
Create Ota Artifact
Deploy Firmware
List Deployments
Get Deployment Stats
Upload Firmware File
Upload Ota Artifact
Shell RBAC
Get the fleet's shell access policy (fleet alias)
Get the fleet's shell access policy (fleet alias)
Update the fleet's shell access policy (fleet alias)
Update the fleet's shell access policy (fleet alias)
Get the org's shell access policy
Get the org's shell access policy
Update the org's shell access policy
Update the org's shell access policy
List Shell Access Group members
List Shell Access Group members
Add a user to the Shell Access Group
Add a user to the Shell Access Group
Remove a user from the Shell Access Group
Remove a user from the Shell Access Group
List the current user's own active shell role grants
List the current user's own active shell role grants
List active shell role grants for a user
List active shell role grants for a user
Grant a shell role to a user
Grant a shell role to a user
Revoke a shell role from a user
Revoke a shell role from a user
Health
Health Check
Liveness Check
Readiness Check
Internal (MCU-Server)
Report the org's mcu_ota entitlement state for MCU-Server's own gating.
Report the org's mcu_ota entitlement state for MCU-Server's own gating.
Internal (Gateway)
Validate a per-device sotc_ tunnel token (frp httpPlugins callback).
Reconcile stale active sessions on gateway restart (TASK-S21-006).
Reconcile stale active sessions on gateway restart (TASK-S21-006).
Mark a shell session as ended (gateway callback).
Mark a shell session as ended (gateway callback).
Attach a recording URI + SHA-256 to a shell session (gateway callback).
Attach a recording URI + SHA-256 to a shell session (gateway callback).
Resolve organization_id/status/recording_uri for an orphaned .cast sweep (GAP-BE-007).
Resolve organization_id/status/recording_uri for an orphaned .cast sweep (GAP-BE-007).
Internal (frps)
Validate a per-device sotc_ tunnel token (frp httpPlugins callback).
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
Reboot Events
List Reboot Events
Get Reboot Statistics
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
Request Email Change
Confirm Email Change
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
Report Reboot
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
Reference
Third-Party Licenses
GitHub
Select theme
Dark
Light
Auto
Health Check
GET
/api/health
Basic health check
Responses
200
Successful Response
Select media type
application/json
