Skip to content
TinyConductorTinyConductorTinyConductor

Get the background work of the engine that answers

GET
/api/v1/console/health/background
curl --request GET \
  --url http://localhost:8080/api/v1/console/health/background \
  --header 'Authorization: Bearer <token>'
Available inEmbeddedBundledCluster
AuthAuthenticated Bearer token

What the janitor, retention, back-pressure and the export did on the engine node that answers since it started, as JSON: janitor (its passes, the last one’s time, and per partition the expired idempotency claims and pruned log frames), retention (the day partitions created and dropped, and per tenant the records purged and the rows moved into the long-running partition), backpressure (per tenant, the creates slowed and the writes refused because its export lagged or stopped) and export (per partition, its committed sequence and pruning floor, and per tenant the last exported tenant sequence, what waits and why its export stopped). A service client sees the whole node (scope: node); anyone else sees only its own tenant’s rows and none of the per-partition figures other tenants share (scope: tenant, janitor.partitions and each partition’s committedSeq and floor are null). In Embedded, which runs in one process with its state in memory, the answer is kept: false with the reason. Requires operations:health.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
x-tenant-id
string
>= 1 characters

Tenant selection. A principal of one tenant may omit it, and if sent it must name that tenant. A principal that may act in several tenants sends it on every request.

Responses

Section titled “ Responses ”

200

Section titled “200”

The background work within the caller’s scope

Media typeapplication/json
object
Examplegenerated
{}

400

Section titled “400”

Invalid request

Media typeapplication/problem+json
object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:invalid-argument",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request is malformed",
  "instance": "/api/v1/console/health/background"
}

401

Section titled “401”

Authentication required

Media typeapplication/problem+json
object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer credential is required",
  "instance": "/api/v1/console/health/background"
}

Headers

Section titled “Headers”
WWW-Authenticate
string

403

Section titled “403”

The caller lacks the required permission.

Media typeapplication/problem+json
object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The principal lacks the action this route requires",
  "instance": "/api/v1/console/health/background"
}

404

Section titled “404”

Tenant-scoped resource not found

Media typeapplication/problem+json
object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource does not exist",
  "instance": "/api/v1/console/health/background"
}

409

Section titled “409”

Idempotency conflict

Media typeapplication/problem+json
object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:conflict",
  "title": "Conflict",
  "status": 409,
  "detail": "The idempotency key is already associated with another request",
  "instance": "/api/v1/console/health/background"
}

413

Section titled “413”

Authenticated request exceeds its configured bound

Media typeapplication/problem+json
object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:payload-too-large",
  "title": "Payload Too Large",
  "status": 413,
  "detail": "The request exceeds the configured size limit",
  "instance": "/api/v1/console/health/background"
}

429

Section titled “429”

Tenant quota exhausted

Media typeapplication/problem+json
object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:quota-exhausted",
  "title": "Quota Exhausted",
  "status": 429,
  "detail": "The tenant active-instance quota is exhausted",
  "instance": "/api/v1/console/health/background"
}

500

Section titled “500”

Non-leaking internal failure

Media typeapplication/problem+json
object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:internal",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The request could not be completed",
  "instance": "/api/v1/console/health/background"
}

501

Section titled “501”

The operation is on the reviewed allow-list of what this deployment mode cannot serve.

Media typeapplication/problem+json
object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:mode-not-supported",
  "title": "Mode Not Supported",
  "status": 501,
  "detail": "GET /api/v1/console/health/background is not supported in embedded mode",
  "instance": "/api/v1/console/health/background",
  "mode": "embedded"
}

503

Section titled “503”

Backpressure or dependency unavailable

Media typeapplication/problem+json
object
type
required
string
/^urn:bpm:error:/
title
required
string
status
required
integer
>= 400 <= 599
detail
required
string
instance
required

The request path.

string
mode

Present only on mode-not-supported. It names the engine’s mode.

string
Example
{
  "type": "urn:bpm:error:unavailable",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "The required engine service is not ready",
  "instance": "/api/v1/console/health/background"
}