Skip to content

Browse all realms

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

Returns available realms grouped by provider/account. The complete field is false when a source scan failed or returned partial results.

Realms grouped by provider

Media type*/*

Every realm the directory knows, grouped by the account or organisation that publishes it

object
complete
required

False when a source scan failed or returned partial results, so some realms may be missing

boolean
providers
required

One group per publisher

Array<object>

The realms one publisher offers

object
provider
required

The publishing account or organisation, from the entry’s from metadata, or “unknown”

string
realms
required

That publisher’s realms

Array<object>

One installable realm as the browse lists it

object
description
required

What the realm is for, as its publisher describes it

string
installed
required

True when a realm of this name is already loaded in the caller’s world

boolean
metadata
required

The source’s own extras for this realm, passed through as reported. Open by contract

object
key
additional properties
any
name
required

The realm’s name, as an install names it

string
source
required

Where the realm installs from: a git clone URL or registry identifier

string
url

A human-readable page for the realm, or null when the source has none

string

Directory scan incomplete and no realms available; use Refresh directory to retry

Media type*/*

The realm scan is incomplete and found nothing, so there is no partial catalogue to show

object
message
required

What to do about it, written to be shown

string