/
25
256foundation
/
Braiins OS Public REST API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2h ago · Updated 1mo ago
latest
OpenAPI 3.1.0
2026-07-17
57
128
164.2 KB
d341c8e1d506
Actions
9
put
Factory Reset
get
Get locate device status
put
Set locate device status
put
Pause mining
put
Reboot
put
Restart
put
Resume mining
put
Start
put
Stop
Authentication
2
post
User login
put
Set or remove user password
Configuration
2
get
Get constraints
get
Get miner configuration
Cooling
2
put
Set cooling mode
get
Get cooling state
Documentation
1
get
Retrieve OpenAPI JSON schema
License
2
put
Apply custom contract key
get
Get license state
Miner
8
get
Get miner details
get
Get miner errors
get
Get hashboard details
patch
Enable or disable hashboards
get
Stream log file
get
Get miner statistics
get
Stream miner status updates
get
Stream support archive
Network
3
get
Retrieve miner network information
get
Get network configuration
patch
Update network configuration
Performance
18
put
Set DPS (Dynamic Performance Scaling)
put
Set hashrate target
patch
Decrement hashrate target
put
Set default hashrate target
patch
Increment hashrate target
patch
Set hashrate target to a relative reference
get
Get performance mode
put
Set performance mode
put
Set power target
patch
Decrement power target
put
Set default power target
patch
Increment power target
patch
Set power target to a relative reference
put
Set quick ramping
put
Set default quick ramping
get
Get target profiles
delete
Remove tuner profiles
get
Get tuner state
Pools
5
get
Get Pool Groups
post
Create a new pool group
put
Set multiple pool groups
put
Update an existing pool group
delete
Delete a pool group by UID
Upgrade
4
get
Get auto-upgrade settings
patch
Set auto-upgrade settings
post
Restore stock
post
System upgrade
Version
1
get
Get API version
Actions
Factory Reset
Performs Factory Reset.
put
/api/v1/actions/factory-reset
Response
Successful response.