Skip to content

System configuration REST interface

Get default values from sys.config

Retrieve the current default values in the system configuration file.

Definition

1
GET /api/system

Example request

1
curl -X GET "http://127.0.0.1:8080/api/system"

Example response

1
2
3
4
5
6
7
8
{
  "enableOrch": true,
  "orchVersion": "v1",
  "enableTopoGraph": true,
  "enablePopupMessages": true,
  "enableForceSSL": false,
  "forceWebsocketSSL": false
}

Example responses if licence expired

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "enableOrch": true,
  "orchVersion": "v1",
  "enableTopoGraph": true,
  "enablePopupMessages": true,
  "enableForceSSL": false,
  "forceWebsocketSSL": false,
  "expiryInfo": "allowed_with_warning",
  "expiryText": "The license expired on 2015-12-31. WombatOAM will stop working"
                "after 2016-01-31. Please renew your license by contacting "
                "your Erlang Solutions sales representative or "
                "wombat@erlang-solutions.com."
}

Arguments

None.

Returns

An object with the current configuration settings.

Help/about REST interface

Get license text

Retrieve the WombatOAM licence text

Definition

1
GET /api/help/about

Example request

1
curl -X GET "http://127.0.0.1:8080/api/help/about"

Example response

1
2
3
{
  "text": "This is WombatOAM, an operations and maintenance tool for Erlang systems ...
}

Arguments

None.

Returns

The full WombatOAM licence text. Only the first line is shown in the example response.