org-biome-installations
Operations of the Biome Host API. Paths are relative to your deployment's API host.
GET /api/biome-host-api/org-biome-installations
List this org's ORG-SCOPED biome installations (projectId IS NULL). Optionally only those of one biomeId. Archived installations are excluded unless includeArchived=true.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
biomeId | query | string | no | Return only installations of this biome (the manifest xema.id, lowercase kebab-case). Absent: every biome. A biome with no installation answers an empty list. |
includeArchived | query | boolean | no | Include installations whose lifecycle is archived. Default false — archived is terminal: archived rows are never resolved and are ineligible for runtime contribution, so listing one advertises an install nothing will route to. |
| Status | Description | Body |
|---|---|---|
| 200 | application/json BiomeInstallationResponseDtoDataArrayEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/biome-host-api/org-biome-installations/{id}
Get a single ORG-SCOPED biome installation by id (scoped to this org and projectId IS NULL).
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json BiomeInstallationDetailResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
PUT /api/biome-host-api/org-biome-installations/{id}
Reconcile an ORG-SCOPED installation's in-place spec (configJson, integrations, resources). The pinned version is immutable here — a version change requires a reinstall and is rejected with 409. Re-stamps iac ownership for the declarative control plane; a person's own edit (an org admin, or a member holding the install permission for the row's scope) adopts an unowned row to ui and leaves an owned one with its owner.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Request body: application/json UpdateOrgBiomeInstallationDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json BiomeInstallationResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
DELETE /api/biome-host-api/org-biome-installations/{id}
Uninstall an ORG-SCOPED biome installation. Idempotent — deleting an already-gone install returns 200 with existed=false so a reconciler retry is safe. Tears down any workload, deletes the row and starts the uninstall cascade, whose workflowId is returned (null when nothing was deleted). 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.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json OrgBiomeInstallationDeleteResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
POST /api/biome-host-api/org-biome-installations/{id}/rescope
Promote an installation's owner — user → project → org. Only broadening moves are legal; a demotion or a same-tier move is refused with 422. Publishing to org scope requires the org admin role; a personal installation may only be promoted by its own owner. A collision at the target scope is a 409 — re-scoping never merges two installations.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Request body: application/json RescopeBiomeInstallationDto
| Status | Description | Body |
|---|---|---|
| 200 | application/json BiomeInstallationRescopeResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |