Braiins

Braiins Actions API

The Actions API from Braiins — 8 operation(s) for actions.

GitHub OpenAPI

Operations 9

PUT /api/v1/actions/factory-reset Factory Reset #
GET /api/v1/actions/locate Get locate device status #
PUT /api/v1/actions/locate Set locate device status #
PUT /api/v1/actions/pause Pause mining #
PUT /api/v1/actions/reboot Reboot #
PUT /api/v1/actions/restart Restart #
PUT /api/v1/actions/resume Resume mining #
PUT /api/v1/actions/start Start #
PUT /api/v1/actions/stop Stop #

Documentation

📖
Documentation
https://academy.braiins.com/braiins-os/papi-about.md
📖
APIReference
https://developer.braiins-os.com/latest/openapi.html
📖
Documentation
https://academy.braiins.com/braiins-hashpower/api.md
📖
APIReference
https://hashpower.braiins.com/api
📖
GettingStarted
https://academy.braiins.com/braiins-hashpower/quick-start.md

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/braiins-academy/refs/heads/main/openapi/braiins-academy-actions-api-openapi.yml

Other Resources

🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/braiins-academy/refs/heads/main/grpc/braiins-academy-bos-miner.proto
🔗
SourceCode
https://github.com/braiins/bos-plus-api
🔗
Examples
https://github.com/braiins/bos-plus-api-demos
🔗
ChangeLog
https://academy.braiins.com/braiins-os/papi-changelog.md
🔗
Pricing
https://academy.braiins.com/braiins-hashpower/fees.md
🔗
TermsOfService
https://hashpower.braiins.com/terms-and-conditions.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/braiins-academy-actions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

braiins-academy-actions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Braiins OS Public REST Actions API
  description: ''
  contact:
    name: Braiins
    url: https://help.braiins.com
    email: help@braiins.com
  license:
    name: ''
  version: 1.7.0
servers:
- url: http://miner/
tags:
- name: Actions
paths:
  /api/v1/actions/factory-reset:
    put:
      tags:
      - Actions
      summary: Factory Reset
      description: Performs Factory Reset.
      operationId: factory_reset
      parameters:
      - name: wipe_network
        in: query
        description: If true, the factory reset also clears the network configuration so the miner returns to DHCP with the stock hostname on the next boot. If omitted or false, the network configuration is preserved (previous behaviour).
        required: false
        schema:
          type: boolean
      responses:
        '204':
          description: Successful response.
  /api/v1/actions/locate:
    get:
      tags:
      - Actions
      summary: Get locate device status
      description: Gets locate device status.
      operationId: getLocateDeviceStatus
      responses:
        '200':
          description: Successful response containing bool if enabled.
          content:
            application/json:
              schema:
                type: boolean
    put:
      tags:
      - Actions
      summary: Set locate device status
      description: Sets locate device status (turn LED blinking on or off).
      operationId: setLocateDeviceStatus
      requestBody:
        description: Enable or disable.
        content:
          application/json:
            schema:
              type: boolean
        required: true
      responses:
        '200':
          description: Successful response containing bool if enabled.
          content:
            application/json:
              schema:
                type: boolean
  /api/v1/actions/pause:
    put:
      tags:
      - Actions
      summary: Pause mining
      description: Pauses mining.
      operationId: pauseMining
      responses:
        '200':
          description: Successful response containing bool if was already paused.
          content:
            application/json:
              schema:
                type: boolean
  /api/v1/actions/reboot:
    put:
      tags:
      - Actions
      summary: Reboot
      description: Reboots mining.
      operationId: reboot
      responses:
        '204':
          description: Successful response.
  /api/v1/actions/restart:
    put:
      tags:
      - Actions
      summary: Restart
      description: Restarts mining.
      operationId: restart
      responses:
        '200':
          description: Successful response containing bool if was already running.
          content:
            application/json:
              schema:
                type: boolean
  /api/v1/actions/resume:
    put:
      tags:
      - Actions
      summary: Resume mining
      description: Resumes mining.
      operationId: resumeMining
      responses:
        '200':
          description: Successful response containing bool if was already mining.
          content:
            application/json:
              schema:
                type: boolean
  /api/v1/actions/start:
    put:
      tags:
      - Actions
      summary: Start
      description: Starts mining.
      operationId: start
      responses:
        '200':
          description: Successful response containing bool if was already running.
          content:
            application/json:
              schema:
                type: boolean
  /api/v1/actions/stop:
    put:
      tags:
      - Actions
      summary: Stop
      description: Stops mining.
      operationId: stop
      responses:
        '200':
          description: Successful response containing bool if was already stopped.
          content:
            application/json:
              schema:
                type: boolean