Agama OpenAPI & Schemas

Agama exposes an HTTP REST API for remote installation management, status reporting, and configuration. The API is formally described using the OpenAPI Specification 3.1.

All specifications and standalone JSON schemas are hosted at stable URLs directly on this site.

Available Specifications

• Nightly (master): Specifications and standalone schemas generated from the latest master branch of Agama.
• Version 16.1 (SLE 16.1): Specifications corresponding to the SLE-16.1 release branch.

---

Stable Schema URLs

You can reference the JSON Schema directly in your Agama profile for editor auto-completion and validation:

{
  "$schema": "https://agama-project.github.io/openapi/nightly/schemas/config.schema.json",
  "product": {
    "id": "Tumbleweed"
  }
}

---

Downloads

Version	Format	Specification	Standalone Schemas
Nightly	JSON	openapi.json openapi-full.json	config.schema.json proposal.schema.json system.schema.json
Nightly	YAML	openapi.yaml openapi-full.yaml	—
16.1	JSON	openapi.json	—
16.1	YAML	openapi.yaml	—