Remove a realm

DELETE

/api/v1/realms/{name}

const url = 'http://localhost:11044/api/v1/realms/example?keepData=false';
const options = {method: 'DELETE', 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 DELETE \
  --url 'http://localhost:11044/api/v1/realms/example?keepData=false' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Removes an installed realm from the world, with the reference nodes it seeded and the documents its sources ingested unless keepData is set; data in the response counts them. With realm admission on, removing also withdraws the realm’s approval, so installing it again approves the version installed then. admission in the response says what happened to it: revoked, none, kept (another copy is still installed), failed or off.

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

name

required

string

Realm name

Query Parameters

keepData

boolean

Keep the reference nodes the realm seeded and the documents it ingested; the response counts what stays

Responses

200

Realm removed

*/*

The realm was removed

object

admission

required

What happened to the realm’s approval

string

Allowed values: revoked none kept failed off

data

What became of the nodes the realm seeded and the documents it ingested, counted per type and per source. Absent when removal touched no data

object

key

additional properties

any

name

required

The realm removed

string

status

required

Always removed

string

Allowed values: removed

404

Nothing installed answers to that name; the message lists what is installed

*/*

A refusal from the realms surface: the word error and the reason

object

message

required

Why the request was refused, written to be shown. A failed install or update carries the underlying failure’s message

string

status

required

Always error

string

Allowed values: error

409

The realm is served from the appliance’s shared realms directory, which no one world owns; a realm a template, org or default-world manifest supplies is removed from this world

*/*

A refusal from the realms surface: the word error and the reason

object

message

required

Why the request was refused, written to be shown. A failed install or update carries the underlying failure’s message

string

status

required

Always error

string

Allowed values: error