Delete world

DELETE

/api/v1/worlds/{name}

const url = 'http://localhost:11044/api/v1/worlds/example';
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/worlds/example \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Deletes a world. Cannot delete the currently active world.

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

name

required

string

Name of one of the current user’s worlds, as listed by GET /worlds; its whole directory, data/ included, is deleted. The active world answers 400 (switch first), a name with no directory 404

Responses

200

World deleted

*/*

A world was deleted, with everything in it. Carries no path, because there is no longer one

object

name

required

The world that was deleted

string

status

required

Always deleted

string

Example

deleted

400

Cannot delete active world

*/*

A refusal from the world management surface. Carries only the reason, with no status word — the status code is the only other fact and the body does not repeat it

object

error

required

Why the operation was refused, written to be shown. Names the world where the refusal is about a particular one

string

404

World not found

*/*

A refusal from the world management surface. Carries only the reason, with no status word — the status code is the only other fact and the body does not repeat it

object

error

required

Why the operation was refused, written to be shown. Names the world where the refusal is about a particular one

string