Overview
Error Handling

Methods

API Documentation (API Version v1)

Monitoring/Services/

DESCRIPTION

This section of the API allows for remotely querying service status data for a server, as well as managing monitoring settings.

get

URL:

https://api.stormondemand.com/v1/Monitoring/Services/get

Description:

Get the current monitoring settings for a server.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
can_monitorAn array of a string of text, containing no newlines or other control characters.
enabledA boolean value (0 or 1).* Required if:
  • unmonitored is not given
servicesAn array of a string of text, containing no newlines or other control characters.* Required if:
  • unmonitored is not given
uniq_idA six-character identifier, containing only capital letters and digits.
unmonitoredA boolean value (0 or 1).* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

monitoringIps

URL:

https://api.stormondemand.com/v1/Monitoring/Services/monitoringIps

Description:

Returns a list of IPs that our monitoring system runs from.

Parameters:

No Values Defined

Returns:

FieldType
ipsAn array of a valid IP address (v4 or v6) or a valid IP address (v4 or v6) with a mask

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

status

URL:

https://api.stormondemand.com/v1/Monitoring/Services/status

Description:

Get the current service status for each monitored service on a server.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
One or more keys matching: a single word, consisting of only letters and digits.A single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

update

URL:

https://api.stormondemand.com/v1/Monitoring/Services/update

Description:

Update service monitoring settings for a server, if they already exist.

Parameters:

ParameterTypeNotes
enabledA boolean value (0 or 1).
servicesAn array of a string of text, containing no newlines or other control characters.
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
can_monitorAn array of a string of text, containing no newlines or other control characters.
enabledA boolean value (0 or 1).* Required if:
  • unmonitored is not given
servicesAn array of a string of text, containing no newlines or other control characters.* Required if:
  • unmonitored is not given
uniq_idA six-character identifier, containing only capital letters and digits.
unmonitoredA boolean value (0 or 1).* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types