Skip to content

The boot phase, with the clock

GET
/api/v1/boot
curl --request GET \
--url http://localhost:11044/api/v1/boot \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Phase is starting, listening or ready, and ready says the same as a boolean. startedAt is when the JVM started, elapsedSeconds how long ago that was, listeningAt and readyAt when the port opened and the application finished starting. worlds counts the worlds built in this process since start (rebuilds included, and counted again under rebuilt), the realms they loaded in total, when the last one finished and how long it took. No user, realm, path or setting is named: counts and timestamps only, since this is answered without signing in. A null is unknown or not yet, never zero.

The server’s boot phase and what it has built so far

Media typeapplication/json

What the server is doing while it starts: its boot phase, when each phase was reached, and the worlds built since. Counts and timestamps only; a null is unknown or not yet, never zero

object
elapsedSeconds
required

Seconds since startedAt, on this answer’s clock

integer format: int64
listeningAt

When the port began listening, or null while it has not

string format: date-time
phase
required

Starting (nothing answers on the port yet), listening (the port is open, the application is still starting) or ready

string
Allowed values: starting listening ready
ready
required

True once the phase is ready

boolean
readyAt

When the application finished starting, or null while it has not

string format: date-time
startedAt
required

When the JVM started

string format: date-time
worlds
required

Worlds built in this process since start, as totals

object
lastLoadSeconds

How long the most recent build took, to the nearest second; null if none has, or it was not measured

integer format: int64
lastLoadedAt

When the most recent build finished, or null if none has

string format: date-time
loaded
required

Worlds built since start, rebuilds included: each is a build

integer format: int32
realmsLoaded
required

Realms loaded across every build since start

integer format: int32
rebuilt
required

Of those, how many were deliberate rebuilds of a world already loaded

integer format: int32

Example

{
"phase": "starting"
}