Skip to end of metadata
Go to start of metadata

Summary


GET /api/v1/groups

List all Element groups visible to the user account, as well as each Element groups' member Elements and monitors.

Returned Fields

For each returned Element group, the following fields are provided:

FieldTypeDescription
descriptionStringdescription of this Element group
elementsArrayan array listing the Elements that belong to this Element group (see Elements Array below for details)
groupIdIntegerID for this Element group's parent group; can return a null value for the top-level group
idIntegerID for this Element group
monitorsArrayan array listing the service monitors that belong to the Elements in this Element group (see Monitors Array below for details)
nameStringthe name of this Element group
Elements Array

The following fields are provided for each Element belonging directly to an Element group:

FieldTypeDescription
idIntegerID for the child Element
isMonitoredBooleanmonitoring status for the child Element
nameStringdisplay name for the child Element
Monitors Array

The following fields are provided for each service monitor belonging to Elements that belong to this Element group:

FieldTypeDescription
elementIdIntegerID of the Element this child service monitor is related to; can be null for unassigned monitors
idIntegerID for the child service monitor
isHiddenBooleanhidden monitors are internal monitors that Uptime Infrastructure Monitor uses, and can generally be ignored
isMonitoredBooleanmonitoring status for the child service monitor
nameStringname of the child service monitor

Response Codes

The following common response codes may result from this operation:

Response CodeCode DescriptionHTTP Status CodeDetails
UT-0400Bad Request400

The request could not be processed by the server due to incorrect syntax.

API commands can be accessed with this format:

https://<hostname>:<port>/api/<api_version>/<end_point>/<id>/<task>

If you encounter this error, ensure the referencing URL is correct.

UT-0404Resource Not Found404The request could not be processed because an object is missing. The endpoint may be omitted from the command, or was spelled incorrectly.
UT-0405Method Not Allowed405

The user does not have permission to perform the requested action. The user's Uptime Infrastructure Monitor permissions (for example, not permitted to Add Elements, Edit, or Delete Elements) stops them from doing the same though the API (POST, PUT, DELETE, respectively).

UT-0500Unknown500

The corresponding HTTP error code (500) is a catch-all error generated by the Web server where an unexpected condition prevented fulfilling the request. View the uptime_controller.log file for possible issues.

UT-0555Unknown Exception500

The corresponding HTTP error code (500) is a catch-all error generated by the Web server where an unexpected condition prevented fulfilling the request. In this case, an exception has occurred; as a starting point, look for this exception in the uptime_controller.log file.

UT-0560Internal Server Error500

The corresponding HTTP error code (500) is a catch-all error generated by the Web server where an unexpected condition prevented fulfilling the request. In this case, an exception caused a stack trace; as a starting point, look for this stack trace in the uptime_controller.log file.

Other response codes that may occur include the following:

Response Code

Code Description

HTTP Status Code

Details

 OK200Information retrieved successfully.
UT-1012Element Group Filter Expired410The filter you are referencing has expired. Created filters persist, by default, for 5 minutes.
UT-1015Invalid Element Group Filter400The Element filter you are referencing does not exist.

Example

List all Element groups visible to the user:

GET https://youruptime/api/v1/groups/


GET /api/v1/groups/{id}

List a specific Element group's member Elements and monitors.

Returned Fields

The following fields are provided:

FieldTypeDescription
descriptionStringdescription of this Element group
elementsArrayan array listing the Elements that belong to this Element group (see Elements Array below for details)
groupIdIntegerID for this Element group's parent group; can return a null value for the top-level group
idIntegerID for this Element group
monitorsArrayan array listing the service monitors that belong to the Elements in this Element group (see Monitors Array below for details)
nameStringthe name of this Element group
Elements Array

The following fields are provided for each Element belonging directly to an Element group:

FieldTypeDescription
idIntegerID for the child Element
isMonitoredBooleanmonitoring status for the child Element
nameStringdisplay name for the child Element
Monitors Array

The following fields are provided for each service monitor belonging to Elements that belong to this Element group:

FieldTypeDescription
elementIdIntegerID of the Element this child service monitor is related to; can be null for unassigned monitors
idIntegerID for the child service monitor
isHiddenBooleanhidden monitors are internal monitors that Uptime Infrastructure Monitor uses, and can generally be ignored
isMonitoredBooleanmonitoring status for the child service monitor
nameStringname of the child service monitor

Response Codes

The following common response codes may result from this operation:

Response CodeCode DescriptionHTTP Status CodeDetails
UT-0400Bad Request400

The request could not be processed by the server due to incorrect syntax.

API commands can be accessed with this format:

https://<hostname>:<port>/api/<api_version>/<end_point>/<id>/<task>

If you encounter this error, ensure the referencing URL is correct.

UT-0404Resource Not Found404The request could not be processed because an object is missing. The endpoint may be omitted from the command, or was spelled incorrectly.
UT-0405Method Not Allowed405

The user does not have permission to perform the requested action. The user's Uptime Infrastructure Monitor permissions (for example, not permitted to Add Elements, Edit, or Delete Elements) stops them from doing the same though the API (POST, PUT, DELETE, respectively).

UT-0500Unknown500

The corresponding HTTP error code (500) is a catch-all error generated by the Web server where an unexpected condition prevented fulfilling the request. View the uptime_controller.log file for possible issues.

UT-0555Unknown Exception500

The corresponding HTTP error code (500) is a catch-all error generated by the Web server where an unexpected condition prevented fulfilling the request. In this case, an exception has occurred; as a starting point, look for this exception in the uptime_controller.log file.

UT-0560Internal Server Error500

The corresponding HTTP error code (500) is a catch-all error generated by the Web server where an unexpected condition prevented fulfilling the request. In this case, an exception caused a stack trace; as a starting point, look for this stack trace in the uptime_controller.log file.

Other response codes that may occur include the following:

Response Code

Code Description

HTTP Status Code

Details

 OK200Information retrieved successfully.
UT-1002Element Group Does Not Exist404

A specifically referenced Element group does not exist.

In such a case, referencing https://youruptime:9997/api/ v1/groups/789/ would return the following:

The element group id '789' does not exist.

UT-1012Element Group Filter Expired410The filter you are referencing has expired. Created filters persist, by default, for 5 minutes.
UT-1015Invalid Element Group Filter400The Element filter you are referencing does not exist.
UT-1044Field Number out of Range

n/a
(JSON validation)

The declared Element group ID needs to be equal to or greater than 1.

Example

List the contents of Element group ID 1:

GET https://youruptime/api/v1/groups/1


GET /api/v1/groups/{id}/status

Display the status of an Element group's member Elements and monitors.

Returned Fields

The following fields are provided for the returned Element group:

FieldTypeDescription
elementStatusArrayan object listing the status of the parent Element for this monitor (see Element Status Array below for details)
idIntegerID for this service monitor
monitorStatusArraythe output message produced the last time the service monitor was executed (see Monitor Status Array below for details)
nameStringname of this service monitor
topologyParentStatusArraylast known status of this service monitor (see Topology Status Array below for details)
Element Status Array

The following fields are provided for each Element in the Element group:

FieldTypeDescription
idIntegerID of the child Element
isMonitoredBooleanmonitoring status for the child Element
nameStringdisplay name of the child Element
messageStringthe output message produced the last time the child Element changed status
statusStringlast known status of the child Element
lastCheckTimeString - Date Timethe last time the child Element's status was successfully checked  
lastTransitionTimeString - Date Timelast time the child Element changed status, which can be used to determine time in its current status
powerStateStringthe current power state of the child Element (only provided for virtual Elements; all other Elements will return null)
Monitor Status Array

The following fields are provided for each service monitor associated with Elements in the Element group:

Field
Type
Description
elementIdIntegerID of the Element this monitor is related to
idIntegerID of the service monitor
isHiddenBooleanhidden monitors are internal monitors that Uptime Infrastructure Monitor uses, and can generally be ignored
isHostCheckBooleanreturns true if this service monitor is the host check for its parent Element
isMonitoredBooleanmonitoring status for the service monitor
nameStringname of the service monitor
messageStringoutput message produced the last time the service monitor was executed
statusStringlast known status of this service monitor
lastCheckTimeString - Date Timethe last time this service monitor was executed successfully
lastTransitionTimeString - Date Timethe last time this service monitor changed status, which can be used to determine time at its current status
Topology Status Array

The topologyParentStatus array can be used to map topological dependency failures using identified parent child Element relationships:

Field
Type
Description
idIntegerID for this service monitor
isMonitoredBooleanmonitoring status for the parent Element
lastCheckTimeString - Date Timethe last time the parent Element was checked successfully
lastTransitionTimeString - Date Timethe last time this parent Element changed status, which can be used to determine time at its current status
messageStringoutput message produced the last time the parent's status changed
nameStringdisplay name of the parent Element
powerStateStringthe current power state of the parent Element (only provided for virtual Elements; all other Elements will return null)
statusStringlast known status of the parent Element

Response Codes

The following common response codes may result from this operation:

Response CodeCode DescriptionHTTP Status CodeDetails
UT-0400Bad Request400

The request could not be processed by the server due to incorrect syntax.

API commands can be accessed with this format:

https://<hostname>:<port>/api/<api_version>/<end_point>/<id>/<task>

If you encounter this error, ensure the referencing URL is correct.

UT-0404Resource Not Found404The request could not be processed because an object is missing. The endpoint may be omitted from the command, or was spelled incorrectly.
UT-0405Method Not Allowed405

The user does not have permission to perform the requested action. The user's Uptime Infrastructure Monitor permissions (for example, not permitted to Add Elements, Edit, or Delete Elements) stops them from doing the same though the API (POST, PUT, DELETE, respectively).

UT-0500Unknown500

The corresponding HTTP error code (500) is a catch-all error generated by the Web server where an unexpected condition prevented fulfilling the request. View the uptime_controller.log file for possible issues.

UT-0555Unknown Exception500

The corresponding HTTP error code (500) is a catch-all error generated by the Web server where an unexpected condition prevented fulfilling the request. In this case, an exception has occurred; as a starting point, look for this exception in the uptime_controller.log file.

UT-0560Internal Server Error500

The corresponding HTTP error code (500) is a catch-all error generated by the Web server where an unexpected condition prevented fulfilling the request. In this case, an exception caused a stack trace; as a starting point, look for this stack trace in the uptime_controller.log file.

Other response codes that may occur include the following:

Response Code

Code Description

HTTP Status Code

Details

 OK200Information retrieved successfully.
UT-1002Element Group Does Not Exist404

A specifically referenced Element group does not exist.

In such a case, referencing https://youruptime:9997/api/ v1/groups/789/ would return the following:

The element group id '789' does not exist.

UT-1012Element Group Filter Expired410The filter you are referencing has expired. Created filters persist, by default, for 5 minutes.
UT-1015Invalid Element Group Filter400The Element filter you are referencing does not exist.
UT-1044Field Number out of Range

n/a
(JSON validation)

The declared Element group ID needs to be equal to or greater than 1.

Example

Retrieve status for Element group ID 1 (by default, the Infrastructure group):

GET https://youruptime/api/v1/groups/1/status

  • No labels