Skip to content
Embabel Worlds

Delete a world-tier named scope

DELETE
/api/v1/admin/kg/ask/scopes/{name}
curl --request DELETE \
  --url http://localhost:11044/api/v1/admin/kg/ask/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 world-tier scope to delete, by the name GET /ask/scopes lists it under. A realm-shipped scope is refused with 409

Query Parameters

Section titled “Query Parameters”
username
string

Optional, and never needed: the call always acts as the signed-in principal. Naming the principal changes nothing; naming anyone else is refused with 403.

Responses

Section titled “Responses”

200

Section titled “200”

The scope as it was before deletion

Media typeapplication/json

A named scope: a declared realm set an ask can be narrowed to via scope=.

object
description
required

What the scope is for, as its focus declares it. Empty when the declaration gives none.

string
name
required

The scope’s name — the value scope= accepts.

string
realms
required

The realm names whose schema the scoped ask sees (plus the always-on core).

Array<string>

Example generated

{
  "description": "example",
  "name": "example",
  "realms": [
    "example"
  ]
}

401

Section titled “401”

No authenticated principal

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

403

Section titled “403”

username names someone other than the signed-in principal

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

404

Section titled “404”

Unknown scope; the declared names travel with the refusal

Media typeapplication/json

The named scope does not exist in the acting user’s world; the ones that do travel with the refusal.

object
available
required

The scope names this world declares (its focuses).

Array<string>
error
required

Names the scope that was not found.

string

Example generated

{
  "available": [
    "example"
  ],
  "error": "example"
}

409

Section titled “409”

The scope is realm-shipped and is removed with its realm

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