---
title: "System upgrade"
method: POST
path: "/api/v1/upgrade/system-upgrade"
tags: ["Upgrade"]
---

# System upgrade

`POST /api/v1/upgrade/system-upgrade`

## Request

- Base URL: `http://miner`
- URL: `http://miner/api/v1/upgrade/system-upgrade`
- Auth: none declared
- TypeScript: <https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/docs/api/v1/upgrade/system-upgrade/post.ts> (a function with typed inputs; its response is checked against the schema)

Performs system upgrade.

## Request body `multipart/form-data`

- SystemUpgradeRequestRest
  - `data` array[], required
    - integer[]
  - `metadata` SystemUpgradeMetadata, required
    - `disable_cleanup` boolean, required: Flag if should disable cleanup of directory, in which uploaded firmware is stored (default is false and do cleanup)
    - `discard_settings` boolean, required: Flag if should discard settings (default is false and keep settings)
    - `hash` string, required: Firmware hash (SHA256 hex encoded)
    - `size` integer, required: Firmware size (bytes)

## Response `204`

Successful response.

## Other responses

- `409`: Another system task is already in progress.
- `500`: Internal server error.

---

[API](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api.md) - [All operations](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/revisions/d341c8e1d506?raw)