Skip to content

Central API — tenant office runtime health

GET/tenants/{tenant_id}/office/health

Returns the office worker and queue health snapshot for a specific tenant, equivalent to the tenant-level /office/runtime/health endpoint but accessible from the central admin API without requiring tenant-level authentication.

Request

Path parameters

NameTypeRequiredDescription
tenant_idstringYes

The tenant identifier.

Responses

200 Office runtime health for the specified tenant

Content type application/json, object · OfficeRuntimeHealthV1.

FieldTypeRequiredDescription
worker_statusstringNo

Overall status of the background render worker.

One of: "healthy", "degraded", "down"

queue_depthintegerNo

Number of jobs currently waiting in the render queue.

processingintegerNo

Number of jobs currently being actively processed.

failed_last_hourintegerNo

Number of render jobs that failed in the last 60 minutes.

average_render_msinteger, nullableNo

Rolling average render time in milliseconds over the last 100 completed jobs.

last_successful_render_atstring (date-time), nullableNo

Timestamp of the most recently successfully completed render job.

libreoffice_versionstring, nullableNo

Version string of the LibreOffice runtime used for document conversion.

404 Tenant not found

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/tenants/{tenant_id}/office/health" \
  -H "Accept: application/json"
Loading