Generated from the committed OpenAPI document, bmcd 2.36.3. Do not edit this file: just refresh-api rewrites it.
SD card capacity and use
Legacy form: GET /api/bmc?opt=get&type=sdcard with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
| response |
body |
meaning |
200 |
application/json — array of SdCard |
The result. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
`200` body (`application/json`) (each element): `SdCard`
| field |
type |
required |
description |
free |
integer (uint64) |
yes |
|
total |
integer (uint64) |
yes |
|
use |
integer (uint64) |
yes |
Named use, not used. Upstream's spelling, and a Rust keyword, which is why the field is renamed rather than called what it means. |
`default` body (`application/problem+json`): `Problem`
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|
What is on the SD card, and which of it can be flashed to a node
Legacy form: GET /api/bmc?opt=get&type=sdcard_files with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
| response |
body |
meaning |
200 |
application/json — array of SdCardEntry |
The result. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
`200` body (`application/json`) (each element): `SdCardEntry`
| field |
type |
required |
description |
directory |
boolean |
yes |
true for a directory, so a client can render a tree without a second request per row. |
flashable |
boolean |
yes |
Whether this could be written to a compute module. |
modified |
integer or null |
no |
Seconds since the epoch, or None where the filesystem will not say. |
name |
string |
yes |
|
path |
string |
yes |
Path relative to the card's root, which is also what a later request sends back. Never absolute: the root is the daemon's to decide. |
reason |
string or null |
no |
Why not, when it is not. Present ONLY alongside flashable: false. A non-candidate is listed rather than hidden: an operator who cannot find the file they just copied will not conclude "it must be too small", they will conclude the page is broken. |
size |
integer (uint64) |
yes |
Bytes. Meaningless for a directory and reported as 0 rather than omitted, because an absent field and a zero are the same thing to most clients and only one of them is true. |
`default` body (`application/problem+json`): `Problem`
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|
Format the SD card
Legacy form: GET /api/bmc?opt=set&type=sdcard with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.
| response |
body |
meaning |
200 |
application/json — — |
The result. Its shape is not described in this document. |
204 |
empty |
Done, with nothing to report. |
default |
application/problem+json — Problem |
A refusal, RFC 9457. |
`default` body (`application/problem+json`): `Problem`
| field |
type |
required |
description |
detail |
string |
no |
|
status |
integer |
yes |
|
title |
string |
yes |
|
type |
string |
no |
|