Skip to content

Delete an action

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

Deletes an action spec from the world’s config/actions directory, along with any sibling TypeScript file of the same name. Realm-shipped and platform actions cannot be deleted.

name
required
string

Name of the world action to delete, matched exactly: its config/actions/<name>.yml is removed, with any sibling <name>.ts. An action without that YAML in this world (realm-shipped or platform-defined) is refused with 400

Action deleted

Media type*/*
object
key
additional properties
string

Action cannot be deleted

Media type*/*

A refused action operation: not found, not editable, not deletable, or a compilation that failed

object
message
required

Why, written to be shown, naming the action

string
status
required

Always error

string
Allowed values: error

Action not found

Media type*/*

A refused action operation: not found, not editable, not deletable, or a compilation that failed

object
message
required

Why, written to be shown, naming the action

string
status
required

Always error

string
Allowed values: error