Skip to content

Disconnect a source: its connection, stored secret and provisional realm, with the nodes that realm seeded

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

Name of the connected source to disconnect; its stored secret and any provisional realm learned from it go too. 404 when it is not a source this user connected

Disconnected

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"
}

The disconnect failed part-way, for instance the world could not be rebuilt without the source; error says why

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"
}

Not a source this user connected

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"
}