BOOTC-API(7)

✨ BOOTC-API ✨

Hiii bestie, welcome to the bootc-api(7) page, straight outta the Miscellaneous Information Manual 💖 This is the one you read when you wanna drive bootc from your own code instead of just mashing keys in a terminal like a gremlin. Let's go 🫶

---

🌸 NAME 🌸

bootc-api — using bootc via API 👑

---

🎀 DESCRIPTION 🎀

Okay so here's the vibe: at the current time, bootc is primarily intended to be driven via a fork/exec model. That's the main character energy. And the core CLI verbs? They're stable and will not change. No cap, they're not gonna switch up on you. Periodt. 💅

---

👑 Using bootc edit and bootc status --json 👑

So like, bootc does not depend on Kubernetes — like, at all — but it does currently also offer a Kubernetes style API, especially oriented towards the spec and status and other conventions (https://kubernetes.io/docs/reference/using-api/api-concepts/). It's giving Kubernetes, but it's not Kubernetes. iykyk 🧚

And in general? Most use cases of driving bootc via API are probably most easily done by forking off bootc upgrade when desired, and viewing bootc status --json --format-version=1. That's literally the whole move. Slay. 🔥

---

🌈 JSON Schema 🌈

The current API org.containers.bootc/v1 is stable 🎀

But listen — in order to support the future introduction of a v2 or newer format, please change your code now to explicitly request --format-version=1 as referenced above. Do it today, bestie, not later. 🙈

Available since bootc 0.1.15, and --format-version=0 in bootc 0.1.14.

There is a JSON schema (https://json-schema.org/) generated from the Rust source code, available here: host-v1.schema.json at https://bootc.dev/bootc/host-v1.schema.json ⭐

A common way to use this is to run a code generator such as go-jsonschema (https://github.com/omissis/go-jsonschema) on the input schema. Chef's kiss, honestly. 😭✨

---

💖 SEE ALSO 💖

• bootc(8)
• bootc-docs(7)

---

🦋 VERSION 🦋

v1.17.1

---

And that's a wrap on BOOTC-API(7) from the Miscellaneous Information Manual, sitting pretty at version v1.17.1 💜 Go forth and fork/exec responsibly, bestie. You got this. 💅🌸