biome-installations

Operations of the Biome Host API. Paths are relative to your deployment's API host.

GET /api/biome-host-api/projects/{projectId}/biome-installations

List biome installations for this project, optionally only those of one biomeId. Archived installations are excluded unless includeArchived=true.

Authentication: bearer token (Authorization: Bearer <token>)

GET /api/biome-host-api/projects/{projectId}/biome-installations/{id}

Get a single biome installation

Authentication: bearer token (Authorization: Bearer <token>)

DELETE /api/biome-host-api/projects/{projectId}/biome-installations/{id}

Hard-delete a biome installation. Tears down the sidecar workload, deletes the row, then starts uninstallBiomeCascadeWorkflow which fans cleanup out to every downstream service that owns biome-scoped rows (workflow-engine, deliverable-specs, mcp-gateway, org-database-pool). The org's workflow definitions and the biome's schema are retired only when no installation of the biome, of any owner, remains in the org. The response carries the workflowId — clients poll the workflow for the terminal outcome (clean | dirty). Use disable instead when you want a temporary, reversible teardown.

Authentication: bearer token (Authorization: Bearer <token>)

POST /api/biome-host-api/projects/{projectId}/biome-installations/{id}/approve-in-store

Approve a submitted biome in the Xema Store. Guarded by biome:approve-in-store@1. Transitions store-submitted → store-approved.

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json LifecycleTransitionAckDto

POST /api/biome-host-api/projects/{projectId}/biome-installations/{id}/archive

Archive a biome installation from any non-archived state. Guarded by biome:archive@1. Terminal — archived rows are never resolved.

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json LifecycleTransitionAckDto

PATCH /api/biome-host-api/projects/{projectId}/biome-installations/{id}/disable

Disable a biome installation without deleting its configuration

Authentication: bearer token (Authorization: Bearer <token>)

PATCH /api/biome-host-api/projects/{projectId}/biome-installations/{id}/enable

Enable a disabled biome installation. The only transition out of disabled: the state becomes active or pending_config per the current configuration and the workload is dispatched again.

Authentication: bearer token (Authorization: Bearer <token>)

POST /api/biome-host-api/projects/{projectId}/biome-installations/{id}/promote

Promote a biome installation across the lifecycle graph (draft → sandbox-installed → review-required → org-installed, or store-approved → org-installed). Guarded by biome:promote@1 at xema-capability-router. Promote-out-of-sandbox additionally requires an acknowledged approval id.

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json PromoteBiomeInstallationDto

PATCH /api/biome-host-api/projects/{projectId}/biome-installations/{id}/resources

Replace the per-adapter resource selector slices on an installation

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json UpdateBiomeInstallationResourcesDto

POST /api/biome-host-api/projects/{projectId}/biome-installations/{id}/submit-to-store

Submit an org-installed biome to the Xema Store. Guarded by biome:submit-to-store@1. Transitions org-installed → store-submitted.

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json LifecycleTransitionAckDto