Delete a user-authored handler (realm handlers can only be disabled)
POST
/api/v1/admin/handlers/delete
const url = 'http://localhost:11044/api/v1/admin/handlers/delete?name=example';const options = {method: 'POST', 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 POST \ --url 'http://localhost:11044/api/v1/admin/handlers/delete?name=example' \ --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”name
required
string
Name of a handler the caller authored. A realm-shipped handler is refused (disable it instead) and an unknown name finds nothing; both answer 200 with ok: false
Responses
Section titled “Responses”Whether it was deleted, and the server’s own sentence about it
Media typeapplication/json
Whether the mutation landed, and what the server has to say about it.
object
message
required
The server’s own sentence about the outcome; on a failed save, the TypeScript errors. Show it rather than replace it.
string
ok
required
Whether the save or delete landed. A save that does not type-check is not persisted.
boolean
Example generated
{ "message": "example", "ok": true}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"}