docs
Advanced search
1.
Get started
Preparation
Prepare a Raspberry Pi device
Prepare a virtual device
Deploy an Application update
Deploy an Operating System update
Monitor your device
Mender Gateway
Microcontroller (preview)
Prepare an ESP32-S3 with Zephyr
Deploy a firmware update
2.
Overview
Introduction
Device Support
Artifact
Device Group
Deployment
Delta update
Identity
Inventory
Customize the update process
Security
Role-Based Access Control
Multi-tenancy
Device Authentication
Compatibility policy
Taxonomy
Requirements
Limits
3.
Client installation
Overview
Installing
Upgrading
Identity
Inventory
Use an Update Module
Use the Device-side API
Configuration
Polling intervals
Configuration options
Integration checklist
4.
Operating System updates: Debian family
Overview
Convert a Mender Debian image
Customization
State scripts
Customize Mender
Delta update support
Mender-monitor support
Provision a new device
Secure Boot
Variables
5.
Operating System updates: Yocto Project
Overview
Board integration
Partition configuration
Bootloader support
GRUB
U-Boot
Manual U-Boot integration
Raw flash
Example: QEMU
Secure Boot
Building for demo
Image customization
Features
Read-only root filesystem
State scripts
Customize Mender
Delta update support
Building for production
Provisioning a new device
Variables
6.
Operating System updates: Zephyr
Overview
Board integration
Bootloader support (MCUBoot)
Customize Mender MCU
Configuration
7.
Orchestrate updates
Overview
Manifest
Create a Manifest Artifact
Topology
Interface Protocol
Installation
Yocto Project
Debian family
Examples
8.
Artifact creation
Create an Artifact
Tutorial: Kubernetes update
Tutorial: Docker Compose update
Create an Artifact with system snapshot
Combining Operating System and Application updates
Modify an Artifact
State scripts
Create a Delta update Artifact
Server-side generation of Delta Artifacts
Standalone deployment
Sign and verify
Create a custom Update Module
Software versioning
Advanced versioning
CI/CD pipelines
GitHub Actions
GitLab CI/CD
Azure DevOps
9.
Server installation
Overview
Architecture
Certificates and keys
Evaluation with Docker Compose
Upgrading from previous versions
Upgrading to Mender 3.7
Upgrading to Mender Server 4.0
Production installation with Kubernetes
Kubernetes
Storage
Mender Server
Backup and Restore
Device license count
Direct Upload
10.
Server integration
Using the APIs
Preauthorizing devices
Mender Gateway
Mutual TLS authentication
Prerequisites
Evaluation with docker
Production installation with Kubernetes
MTLS Ambassador migration guide
Configuration file
Azure IoT Hub integration
AWS IoT Core integration
Webhooks
SAML Federated Authentication
AWS IAM Identity Center
Microsoft Entra ID
Okta
OpenID Connect Federated Authentication
11.
Add-ons
Overview
Configure
How to make an apply-device-config script
Monitor
Installation
Concepts
Supported subsystems
Configuration
Advanced use cases
File Transfer
Installation
Security
Troubleshooting File Transfer
Port forward
Remote Terminal
Installation
Security
Troubleshooting Remote Terminal
Mender Connect
12.
Download
Disk images
Workstation tools
Device components
13.
General
Overview
Build from source code
14.
Server-side API
15.
Device-side API
Overview
Mender Authentication API v1
Mender Update Management API v1
16.
Troubleshoot
Yocto Project build
Yocto Project runtime
Mender Client
Mender Server
Device Runtime
Mender MCU
Hosted Mender - tenant migration
17.
Release information
Supported releases
Release notes & changelog
Mender Server
Mender Server Enterprise
Hosted Mender
Mender Client
mender-connect
mender-configure-module
mender-setup
mender-snapshot
mender-flash
mender-artifact
mender-cli
mender-convert
meta-mender
mender-binary-delta
monitor-client
Mender Gateway
mender-ci-workflows
app-update-module
Mender MCU
Open source licenses
Mender Server
Mender Server Enterprise
mender-artifact
mender-convert
Clear History
Visit mender.io
Device-side API
Edit
Chapter 15
Device-side API
Welcome to the Mender Device-side API reference documentation.
North America
470 Ramona Street Palo Alto, CA 94301
Europe
Gaustadalléen 21 N-0349 Oslo
© 2025 Northern.tech AS