Runtime (DELETE)

Deletes a specific runtime.

Description

The purpose of this API is to allow to cleanup the database. You can delete a runtime only when it is stopped. A runtime that is currently active cannot be deleted.

Roles

Users in the following roles are authorized to perform this operation:

  • mfpadmin

Method

DELETE

Path

/management-apis/2.0/runtimes/runtime-name

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime?locale=de_DE&mode=empty

Path Parameters

runtime-name
The name of the runtime. This is the context root of the runtime web application, without the leading slash.

Query Parameters

Query parameters are optional.

locale
The locale used for error messages.
mode
Whether to delete the runtime only if it has no applications or adapters. Possible values are empty (delete only when empty) and always (delete even when not empty, the default).

Produces

application/json, application/xml, text/xml

Errors

403
The user is not authorized to call this service.
409
The corresponding runtime cannot be deleted. Possible reasons: It is still running, hence you must stop the runtime first.
It is not empty but you passed the mode empty to delete only an empty runtime.
500
An internal error occurred.