Global Configuration (GET)
Retrieves information about the global configuration.
Roles
Users in the following roles are authorized to perform this operation:
- mfpadmin
- mfpdeployer
- mfpmonitor
- mfpoperator
Method
GET
Path
/management-apis/2.0/config
Example
https://www.example.com/mfpadmin/management-apis/2.0/config?locale=de_DE
Query Parameters
Query parameters are optional.
- locale
- The locale used for error messages.
Produces
application/json, application/xml, text/xml
Response
The global configuration.
JSON Example
{
"analyticsConsoleUrl" : [
{
"runtime" : "myruntime",
"url" : "https://www.example.com/analytics/console",
},
...
],
"auditEnabled" : true,
"cloudantDashboardUrl" : "https://example.cloudant.com/dashboard.html",
"iosEdition" : false,
"productVersion" : "8.0",
"pushConfidentialClientsStatus" : "ok",
"pushEnabled" : true,
"swaggerUrl" : "https://www.example.com/doc/?url=https://www.example.com/api/adapterdoc/sampleAdapter",
"topology" : "STANDALONE",
}
XML Example
<?xml version="1.0" encoding="UTF-8"?>
<global-config
auditEnabled="true"
cloudantDashboardUrl="https://example.cloudant.com/dashboard.html"
iosEdition="false"
productVersion="8.0"
pushConfidentialClientsStatus="ok"
pushEnabled="true"
swaggerUrl="https://www.example.com/doc/?url=https://www.example.com/api/adapterdoc/sampleAdapter"
topology="STANDALONE">
<analyticsConsoleUrls>
<analyticsConsoleUrl
runtime="myruntime"
url="https://www.example.com/analytics/console"/>
...
</analyticsConsoleUrls>
</global-config>
Response Properties
The response has the following properties:
- analyticsConsoleUrl
- The array of Analytics console URLs for available runtimes
- auditEnabled
- Whether audit is enabled.
- cloudantDashboardUrl
- The link to the Cloudant dashboard, if any.
- iosEdition
- Whether the server is an iOS Edition.
- productVersion
- The exact product version.
- pushConfidentialClientsStatus
- Status of the internal push and administrative confidential client
- pushEnabled
- Whether the push service is enabled.
- swaggerUrl
- The link to the Swagger UI URL.
- topology
- Server topology. Possible values: "STANDALONE", "CLUSTER" or "FARM"
The analytics-urls has the following properties:
- runtime
- The name of the runtime.
- url
- The URL of the Analytics console.
Errors
403The user is not authorized to call this service.500
An internal error occurred.