Foglight 5.9.7 - REST API Reference Guide

Alarm — Clear alarm by alarm ID


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

API Name: Clear alarm by alarm ID

•

Description: Clear an alarm by its ID.

•

•

API path: /api/v1/alarm/clear/alarmId

•

Sample usage: http://<server>:<port>/api/v1/alarm/clear/1f478dec-f920-4da9-a8d2-b9ba0dcd4394

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Alarm — Get alarm by alarm ID


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

API Name: Get alarm by alarm ID

•

Description: Filter out alarms by alarm ID.

•

•

API path: /api/v1/alarm/alarmId

•

Sample usage: http://<server>:<port>/api/v1/alarm/1f478dec-f920-4da9-a8d2-b9ba0dcd4394

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Alarm — Get alarm by rule ID


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

API Name: Get alarm by rule ID.

•

Description: Filter out alarms by a rule ID. Time range is the default value set in the Management Server, and you can customize the time range using the startTimeMS and durationMS parameter.

•

•

API path: /api/v1/alarm/ruleId/ruleId

•

Sample usage: http://<server>:<port>/api/v1/alarm/ruleId/se478dec-f920-4de9-a8d2-b9ba0dcasd94

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Alarm — Get current alarms


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

API Name: Get current alarms

•

Description: Filter out current alarms.

•

•

API path: /api/v1/alarm/current

•

Sample usage: http://<server>:<port>/api/v1/alarm/current

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Alarm — Get history alarms


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

API Name: Get history alarms

•

Description: Filter out all history alarms.

•

•

API path: /api/v1/alarm/history

•

Sample usage: http://<server>:<port>/api/v1/alarm/history

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Alarm — Get topology object current alarms


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

API Name: Get topology object current alarms

•

Description: Filter out current alarms by the ID of a topology object.

•

•

API path: /api/v1/alarm/current/topologyId

•

Sample usage: http://<server>:<port>/api/v1/alarm/current/se478dec-f920-4de9-a8d2-b9ba0dcasd94

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Alarm — Get topology object history alarms


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

API Name: Get topology object history alarms

•

Description: Filter out history alarms by the ID of a topology object.

•

•

API path: /api/v1/alarm/history/topologyId

•

Sample usage: http://<server>:<port>/api/v1/alarm/history/se478dec-f920-4de9-a8d2-b9ba0dcasd94

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

def rule = server.RuleService.getAllRules().find{


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

Alarm — Push alarms

•

API Name: Push alarms

•

Description: Push an alarm to an existing topology object, and the imported alarm will show on the Alarm dashboard. The “topologyObjectId” field is mandatory and the "ruleId" field is optional. This API set the value of “ruleId” to ExternalAlarm by default, if this field is not set. If you invoke this API using both fields, ensure that ruleId is properly defined to link with its topologyObjectId; otherwise the alarm might be imported into a wrong topology object. Consider for example a rule “CPU Utilization” is related to the "HostCPUs" object. If you define topologyObjectId to Host, this API imports CPU Utilization to the Host object. Postman provides "Alarm - Push Alarm XML" and "Alarm - Push Alarm JSON” sample codes for reference. Click here to download and import the sample codes.

•

Request type: POST

•

API path: /api/v1/alarm/pushAlarm

•

Sample usage: When using the pushAlarm API, note the following:

•

Make sure to use the following as the value of alarmMessage: AAA. BBB. AAA represents the title of the alarm dialog box, while BBB stands for the alarm message. Make sure to add a space between “.” and “BBB”.

•

To get the value of ruleId, do either of the following:

•

Invoke the Rule — Get all rules’ data API.

•

Execute the following scripts in the Administration > Tooling > Script Console dashboard:

def ruleName = <RULE_NAME>

return "Rule not found."

}

The following illustrates the sample code of request body in XML and JSON separately.

Request body in XML:

<alarmMessage>title of alarm dialog. alarm message</alarmMessage>

</externalAlarmParamBean>

Request body in JSON

{"alarmMessage":"title of alarm dialog. alarm message”, "severity":"2", "topologyObjectId":"94e27d92-08a5-4c28-9a90-8856a7689105"}

•

Severity value:


Value	Description
2	Warning
3	Critical
4	Fatal

•

The token is retrieved after successfully logging in to the Management Server.

String

Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

Content-Type

String

•

Data format = JSON, this value is application/json”.

•

Data format = XML, this value is “application/xml”.

•

Alarm — Push alarms by properties


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

API Name: Push alarms by properties

•

Description: Push alarms based on the properties of a topology object.

•

Request type: POST

•

API path: /api/v1/alarm/pushAlarmByProperties

•

Sample usage: The following illustrates the sample code of request body in XML and JSON separately.

Request body in XML:

<alarmMessage>Test Alarm.This is a test alarm message from postman</alarmMessage>

<entry>

<value>nameofHost</value>

</entry>

</properties>

</externalAlarmParamBean>

Request body in JSON

{"alarmMessage":"This is a test alarm message from postman. asdfasdf", "severity":"2", "type":"Host", "properties":{"name":"nameofHost"}, "ruleId":"72b73d98-8c6c-4ee1-b5ba-fd7c14645280"}

Alarm — Push alarms by query

•

API Name: Push alarms by query

•

Description: Push alarms using the query.

•

Request type: POST

•

API path: /api/v1/alarm/pushAlarmByQuery

•

Sample usage: The following illustrates the sample code of request body in XML and JSON separately.

Request body in XML:

<alarmMessage>Test Alarm.This is a test alarm message from postman</alarmMessage>

<query>!Host:name="nameofHost"</query>

</externalAlarmParamBean>

Request body in JSON

{"alarmMessage":"This is a test alarm message from postman. asdfasdf", "severity":"2", "query":"!Host:name='nameofHost'"}

Cartridge

The Cartridge related APIs include the following:

•

Cartridge — Get all cartridges’ data

•

Cartridge — Get all core cartridges’ data

•

Cartridge — Get all non-core cartridges’ data

Cartridge — Get all cartridges’ data

•

API Name: Get all cartridge’s data

•

Description: Get data of all cartridges.

•

•

API path: /api/v1/cartridge/allCartridges

•

Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Cartridge — Get all core cartridges’ data


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

API Name: Get all core cartridge’s data

•

Description: Get data of all the core cartridges.

•

•

API path: /api/v1/cartridge/allCartridges/core

•

Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/core

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Cartridge — Get all non-core cartridges’ data


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

•

API Name: Get all non-core cartridge’s data

•

Description: Get data of all the non-core cartridges.

•

•

API path: /api/v1/cartridge/allCartridges/nonCore

•

Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/nonCore

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Registry — Get all registries’ data


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

Registry

•

•

API Name: Get all registries’ data

•

Description: Get data of all registries.

•

•

API path: /api/v1/registry/allRegistries

•

Sample usage: http://<server>:<port>/api/v1/registry/allRegistries

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•

Remote client — Get all remote clients’ data


Field	Type	Description
status	String	The response status.
data	String	Either the response data format (JSON/XML) or exception message.
error	String	Error code if some exception occurs; otherwise this field is not shown.

Remote client

•

•

API Name: Get all remote clients’ data

•

Description: Get data of all the remote clients.

•

•

API path: /api/v1/remoteClient/allRemoteClients

•

Sample usage: http://<server>:<port>/api/v1/remoteClient/allRemoteClients

•


Field	Type	Description
Access- Token	String	The token is retrieved after successfully logging in to the Management Server.
Accept	String	Specifies the response data format which can be either application/json or application/xml. The default value is application/json.

•