For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Runtime Lock (DELETE)

Forces the release of the transaction lock of a runtime.

Description

This API should not be used in normal operations.

Transactions are performed sequentually. Hence each transaction such as deploying an application or adapter takes the runtime lock. The next transaction waits until the lock is released. After a serious crash, it may happen that the lock is still taken even though the corresponding transaction crashed. The lock will get automatically released after 30 minutes. However, with this API, we can force the release of the lock earlier.

Forcing the release of the lock when a transaction is currently active may corrupt the system. You should use this API only when you are sure that no transaction is currently active.

Roles

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

• mfpadmin

Method

DELETE

Path

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

Example

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

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.

Produces

application/json, application/xml, text/xml

Response

JSON Example

{
  "busy" : false,
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<lock busy="false"/>

Response Properties

The response has the following properties:

busy

Whether the runtime is still busy with a transaction after forcing the release of the lock.

Errors

403

The user is not authorized to call this service.

500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server administration service