Skip to content
Embabel Worlds

Uninstall a source's provisional realm, with the nodes it seeded. The connection stays

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
name
required
string

Name of the source whose provisional realm is uninstalled; the connection itself stays. 404 when no provisional realm is installed for it

Responses

Section titled “Responses”

200

Section titled “200”

Uninstalled

Media typeapplication/json

A connected source disconnected, or its provisional realm uninstalled, with what became of the data that realm had put into the graph

object
data

What became of the nodes the provisional realm seeded (its scan and anchor doors among them) and the documents it ingested, counted per type and per source, in the shape DELETE /api/v1/realms/{name} reports. Absent when no provisional realm was installed

object
key
additional properties
any
message
required

What was done, written to be shown

string
source
required

The source’s name

string

Example generated

{
  "data": {},
  "message": "example",
  "source": "example"
}

404

Section titled “404”

No provisional realm is installed for this source

Media typeapplication/json

A refusal carrying only its explanation, with no code to branch on

object
error
required

What went wrong, written to be shown. Carries the underlying driver’s or parser’s own message where there is one

string

Example generated

{
  "error": "example"
}