Skip to content

Describe one installed realm

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

The realm’s row from the same Realms view the listing reads, with the same held-back fields.

name
required
string

Realm name

The realm

Media type*/*

An installed realm as the Realms view lists it, with whether the world holds it back. A held-back realm stays installed and listed but offers nothing until the realms it requires are installed at versions it accepts

object
author
required

Who the realm says published it; empty when unstated

string
category
required

The id of the category it says it belongs to; empty when it names none on the list

string
categoryIcon
required

The category’s icon name; empty when it has none

string
categoryLabel
required

The category’s name for people; empty when category is

string
description
required

What the realm says it is for; empty when it says nothing

string
heldBack
required

True while the world holds the realm back because a realm it requires is missing, held back, or at a version it does not accept

boolean
heldBackCode

The problem code that holds it back, such as REALM_REQUIREMENT_MISSING; absent when it is not held back

string
heldBackReason

The sentence of that problem, the same one the realm’s problems carry; absent when it is not held back

string
iconUrl
required

Where to fetch the realm’s icon; empty when it has none

string
installed
required

Always true here: only installed realms are listed

boolean
latestVersion
required

The directory’s version when it knows this realm; empty otherwise

string
maturity
required

experimental, beta, stable or deprecated; empty when unstated

string
missingSources
required

Datasources it names that the world does not declare

Array<string>
name
required

The realm’s name, which every other realm route is keyed by

string
problems
required

How many problems were found loading it; GET /realms/{name}/problems lists them

integer format: int32
provider
required

The account the directory says hosts it; empty when the directory does not know it

string
source
required

Where the directory says to install it from; empty when it does not know it

string
tags
required

Free-text keywords from the realm

Array<string>
url
required

A page to read about it; empty when there is none

string
version
required

The version installed

string

No installed realm has that name. Raised as a status, so it answers the not-found page

Media typetext/html

The Realms view is unavailable, or the engine read failed

Media type*/*

The body the servlet error dispatch answers for a status raised by an exception rather than written by the endpoint. Every failure except 404, which answers the not-found HTML page

object
error
required

The status’s standard reason phrase, such as Bad Request or Forbidden

string
path
required

The request path that failed

string
status
required

The HTTP status code, repeated from the status line

integer format: int32