Skip to content

ApplicationApi ​

All URIs are relative to http://localhost

MethodHTTP requestDescription
eventMetricsGET /system/monitoring/eventsEvent Metrics
getConfigGET /system/configurations/Configuration for configurationKey
jvmMetricsGET /system/monitoring/jvmJVM Metrics
listConfigurationsGET /system/configurationsList Configurations
mongoDbMetricsGET /system/monitoring/mongodbMongoDb Metrics
settingsGET /system/settingsSystem Settings
systemMetricsGET /system/monitoring/systemSystem Metrics
updateConfigurationPATCH /system/configurations/Update Configuration

eventMetrics ​

List eventMetrics()

Event Metrics

Returns the Metrics of events of the running MongoCamp Application.

Parameters ​

This endpoint does not need any parameter.

Return type ​

List

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: Not defined
  • Accept: application/json

getConfig ​

MongoCampConfiguration getConfig(configurationKey)

Configuration for configurationKey

Get Configuration for key

Parameters ​

NameTypeDescriptionNotes
configurationKeyStringconfigurationKey to get[default to null]

Return type ​

MongoCampConfiguration

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: Not defined
  • Accept: application/json

jvmMetrics ​

List jvmMetrics()

JVM Metrics

Returns the JVM Metrics of the running MongoCamp Application

Parameters ​

This endpoint does not need any parameter.

Return type ​

List

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: Not defined
  • Accept: application/json

listConfigurations ​

List listConfigurations()

List Configurations

List all Configurations or filtered

Parameters ​

This endpoint does not need any parameter.

Return type ​

List

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: Not defined
  • Accept: application/json

mongoDbMetrics ​

List mongoDbMetrics()

MongoDb Metrics

Returns the MongoDB Metrics of the running MongoCamp Application

Parameters ​

This endpoint does not need any parameter.

Return type ​

List

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: Not defined
  • Accept: application/json

settings ​

SettingsResponse settings()

System Settings

Returns the Settings of the running MongoCamp Application.

Parameters ​

This endpoint does not need any parameter.

Return type ​

SettingsResponse

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: Not defined
  • Accept: application/json

systemMetrics ​

List systemMetrics()

System Metrics

Returns the Metrics of the MongoCamp System

Parameters ​

This endpoint does not need any parameter.

Return type ​

List

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: Not defined
  • Accept: application/json

updateConfiguration ​

JsonValue_Boolean updateConfiguration(configurationKey, JsonValue_Any)

Update Configuration

Update Configuration with the value

Parameters ​

NameTypeDescriptionNotes
configurationKeyStringconfigurationKey to edit[default to null]
JsonValue_AnyJsonValue_Any

Return type ​

JsonValue_Boolean

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: application/json
  • Accept: application/json, text/plain

Released under the Apache License 2.0.