Skip to content
Embabel Worlds

Which installed realms have a newer version upstream

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

Compares each git-backed realm’s local checkout to its remote refs (ls-remote — no objects are transferred). Remote reads are remembered for minutes and refreshed in the background; checkedAt is when each was read. behind is null when it cannot be determined, including while a realm’s first read is still running.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Per-realm update state

Media typeapplication/json

Per installed realm, whether its upstream has moved

object
results
required

One row per loaded realm

Array<object>

Whether one realm has a newer version upstream. A legacy per-world clone answers only name, behind and detail

object
behind

True when there is something to pull, false when current, null when it cannot be told — including while the first read is still running

boolean
checkedAt

When the remote was read, ISO-8601. Absent for a legacy clone, null when not yet read

string
current

The local checkout’s revision. Absent for a legacy clone

string
detail
required

Why the answer is what it is, in words a user can act on. Always present, including for the unknowns

string
latest

The remote’s revision. Absent for a legacy clone

string
name
required

The realm’s name

string

Example generated

{
  "results": [
    {
      "behind": true,
      "checkedAt": "example",
      "current": "example",
      "detail": "example",
      "latest": "example",
      "name": "example"
    }
  ]
}