Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Response Code

Code Description

HTTP Status Code

Details

 OK200Information retrieved successfully.
UT-1000Element Does Not Exist404

A specifically referenced Element ID does not exist.

In such a case, referencing:

https://youruptime:9997/api/v1/elements/12345

returns the following:

The element id '12345' does not exist.

The Element ID endpoint may be omitted, was inputted incorrectly, or is ignored in up.time.

UT-1010Element Filter Expired410

The referenced filter expired. Created filters persist, by default, for five minutes.

UT-1012Element Group Filter Expired410The referenced group filter expired. Created filters persist, by default, for five minutes.
UT-1013Invalid Element Filter400The JSON used to create an Element filter is invalid, and cannot be parsed. Check to ensure you are posting well-formed JSON.
UT-1015Invalid Element Group Filter400The JSON used to create an Element group filter is invalid, and cannot be parsed. Check to ensure you are posting well-formed JSON.
UT-1028URL ID Body Mismatch400The Element ID in the URL and the JSON object do not match.

...

Response Code

Code Description

HTTP Status Code

Details

 OK200Information retrieved successfully.
UT-1011Monitor Filter Expired410

The referenced filter expired. Created filters persist, by default, for five minutes.

UT-1014Invalid Monitor Filter400The referenced Element filter does not exist.

Example

To list all service monitors:

...

Response Code

Code Description

HTTP Status Code

Details

 OK200Information retrieved successfully.
UT-1001Monitor Does Not Exist404

A specifically referenced service monitor ID does not exist.

In such a case, referencing
https://youruptime:9997/api/v1/monitors/456/
returns the following:

The service monitor id '456' does not exist.

UT-1011Monitor Filter Expired410

The referenced filter expired. Created filters persist, by default, for five minutes.

UT-1014Invalid Monitor Filter400The referenced Element filter does not exist.

Example

List a specific service monitor (for example, ID #364):

...

Response Code

Code Description

HTTP Status Code

Details

 OK200Information retrieved successfully.
UT-1001Monitor Does Not Exist404

A specifically referenced service monitor ID does not exist.

In such a case, referencing
https://youruptime:9997/api/v1/monitors/456/
returns the following:

The service monitor id '456' does not exist.

UT-1011Monitor Filter Expired410

The referenced filter expired. Created filters persist, by default, for five minutes.

UT-1014Invalid Monitor Filter400The referenced Element filter does not exist.

Example

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

Code Block
{
   "elementId": 1,
   "elementStatus": 
   {
         "id": 1,
         "isMonitored": true,
         "lastCheckTime": "2012-09-17T14:14:17",
         "lastTransitionTime": "2012-09-13T11:34:24",
         "message": "",
         "name": "win-dleith",
         "powerState": "On",
         "status": "OK"
   },
   "id": 1,
   "isHidden": false,
   "isHostCheck": false,
   "isMonitored": true,
   "lastCheckTime": "2012-09-17T14:13:56",
   "lastTransitionTime": "2012-09-13T11:34:38",
   "message": "",
   "name": "UPTIME-win-dleith",
   "status": "UNKNOWN"
}