List installed realms

GET

/api/v1/realms

const url = 'http://localhost:11044/api/v1/realms';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Returns all realms installed in the world — the shipped Realms view’s rows, filtered to installed, so this listing and a MATCH (r:Realm) query can never disagree.

Authorizations

apiKeyAuth
basicAuth

Responses

200

List of realms

*/*

Array<object>

object

key

additional properties

500

The Realms view is unavailable, or the engine read failed. Deliberately not an empty list: a failed read must never present as no realms installed

*/*

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