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

Runtime Configuration (GET)

Retrieves the user configuration of a specific runtime.

Roles

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

• mfpadmin
• mfpdeployer
• mfpmonitor
• mfpoperator

Method

GET

Path

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

Example

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

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.

flattened

If true (default), the configuration is a flat list of properties, otherwise a hierarchy of objects.

locale

The locale used for error messages.

mode

If no mode is specified, it returns the current user configuration. If the mode defaults is specified, it returns the default configuration.

Produces

application/json, application/xml, text/xml

Response

The user configuration of the specified runtime.

JSON Example

{
  "adapters" : {
    "compressResponseThreshold" : {
      "value" : 20480,
    },
  },
  "analytics" : {
    "additionalPackages" : {
      "value" : "com.admin.util",
    },
  },
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<runtimeconfig>
  <adapters>
    <compressResponseThreshold value="20480"/>
  </adapters>
  <analytics>
    <additionalPackages value="com.admin.util"/>
  </analytics>
</runtimeconfig>

Response Properties

The response has the following properties:

adapters

The runtime properties for adapter.

analytics

The runtime properties for analtyics

The adapter-property has the following properties:

compressResponseThreshold

Compression threshold, in bytes, from which the server tries to compress the MobileFirst adapter response if the client accepts gzip.

The compressthreshold has the following properties:

value

The value of the compression threshold

The analytics-property has the following properties:

additionalPackages

A comma-separated list of packages that the logger uses to generate the output sent to the MobileFirst Analytics server.

The additional package has the following properties:

value

The list of packages that the logger uses

Errors

403

The user is not authorized to call this service.

404

The corresponding runtime is not found.

500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server administration service