Runtimes (GET)

Retrieves metadata for the list of runtimes.

Roles

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

mfpadmin
mfpdeployer
mfpmonitor
mfpoperator

Method

GET

Path

/management-apis/2.0/runtimes

Example

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

Query Parameters

Query parameters are optional.

locale: The locale used for error messages.
mode: The default mode running retrieves only the running runtimes, while the mode db retrieves also the runtimes stored in the database that might not be running.

Produces

application/json, application/xml, text/xml

Response

The metadata for the list of runtimes.

JSON Example

{
  "productVersion" : "8.0",
  "projects" : [
    {
      "apiVersion" : "2.0",
      "link" : "https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime",
      "name" : "myruntime",
      "running" : true,
      "synchronizationStatus" : "ok",
    },
    ...
  ],
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<projectconfiguration productVersion="8.0">
  <projects>
    <project
      apiVersion="2.0"
      link="https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime"
      name="myruntime"
      running="true"
      synchronizationStatus="ok"/>
    ...
  </projects>
</projectconfiguration>

Response Properties

The response has the following properties:

productVersion: The exact product version.
projects: The array of runtimes.

The runtime has the following properties:

apiVersion: The API version
link: The URL to access detail information about the runtime.
name: The name of the runtime. This is the context root of the runtime web application, without the leading slash.
running: Whether the runtime is currently active or has stopped.
synchronizationStatus: The status of the nodes of the runtime. Can contain the values "ok" if all nodes of the runtime are running without error, "synchronizing" if some node is in progress of synchronizing, or an error message if some nodes failed to synchronize.

Errors

403

The user is not authorized to call this service.

500

An internal error occurred.