public-exposure

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

GET /api/biome-host-api/platform/settings/public-exposure

Read the installation public-exposure document; configured is false when never set

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

StatusDescriptionBody
200application/json PublicExposureResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

PUT /api/biome-host-api/platform/settings/public-exposure

Replace the installation public-exposure document. The whole document is refused with every problem named when any entry is invalid. Audited; returns the new revision. A stale expectedRevision is refused with 409

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

Request body: application/json SetPublicExposureDto

StatusDescriptionBody
200application/json PublicExposureResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto