Delete one of the caller's captured scopes
DELETE
/api/v1/kg/studio/scopes/{name}
const url = 'http://localhost:11044/api/v1/kg/studio/scopes/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/kg/studio/scopes/example \ --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
The captured scope’s name, as given in captureAs and listed by GET /kg/studio/scopes; an unknown or expired name is not an error and answers deleted: false
Responses
Section titled “Responses”Whether anything was deleted
Media typeapplication/json
The outcome of deleting a captured scope.
object
deleted
required
True when a scope was dropped; false when the user had no live scope of that name, which is not an error.
boolean
name
required
The scope name from the path, echoed back.
string
Example generated
{ "deleted": true, "name": "example"}Not authenticated
Media typeapplication/json
A refusal carrying only a human-readable reason.
object
error
required
What went wrong, in the terms the caller can act on.
string
Example generated
{ "error": "example"}