Skip to content

Delete a custom role

DELETE
/api/v1/config/router/roles/{id}
curl --request DELETE \
--url http://localhost:11044/api/v1/config/router/roles/example \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Refused while a context still uses it.

id
required
string

The custom role’s id

Deleted

Media type*/*

The change was applied and the world’s config saved; it takes effect on the next request

object
ok
required

Always true. A client that only branches on the status code can ignore it; one that reads the body does not have to special-case the shape

boolean

Not a custom role

Media type*/*

The change was refused and nothing was saved. The status code says which kind of refusal: 400 for something unknown or invalid, 409 while a context still uses the role

object
detail
required

Why it was refused, written to be shown. Carries the router’s own sentence, which names the context, role or model at fault

string
ok
required

Always false

boolean

A context still uses it

Media type*/*

The change was refused and nothing was saved. The status code says which kind of refusal: 400 for something unknown or invalid, 409 while a context still uses the role

object
detail
required

Why it was refused, written to be shown. Carries the router’s own sentence, which names the context, role or model at fault

string
ok
required

Always false

boolean