Versions Compared

Key

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

...

Code Block
POST https://youruptime/api/v1/<endPoint>/filter
  
{ ids : [a,b,c] }

The response will include includes a newly created filter ID for the collection of endpoints:

...

For "monitor" and "group" object types, the IDs provided in the POST request correspond to the id field for the objects being filtered. The object ID provided must match the object type declared in the request.

...

Code Block
    [
        {
        "acknowledgedComment": null,
        "elementId": 556,
        "elementStatus": {
            "id": 556,
            "isMonitored": true,
            "lastCheckTime": "20152016-01-15T10:36:40",
            "lastTransitionTime": "20152016-10-01T08:35:16",
            "message": null,
            "name": "Aetos",
            "powerState": null,
            "status": "OK"
        },
        "id": 21801,
        "isAcknowledged": false,
        "isHidden": false,
        "isHostCheck": false,
        "isMonitored": true,
        "lastCheckTime": "20152016-01-15T10:31:58",
        "lastTransitionTime": "20152016-01-15T10:02:15",
        "message": " Unable to contact Agent (Aetos on port 3333)",
        "name": "UPTIME-Aetos",
        "status": "CRIT"
        },
        {
        "acknowledgedComment": null,
        "elementId": 556,
        "elementStatus": {
            "id": 556,
            "isMonitored": true,
            "lastCheckTime": "20152016-01-15T10:36:40",
            "lastTransitionTime": "20152016-10-01T08:35:16",
            "message": null,
            "name": "Aetos",
            "powerState": null,
            "status": "OK"
        },
        "id": 21802,
        "isAcknowledged": false,
        "isHidden": false,
        "isHostCheck": true,
        "isMonitored": true,
        "lastCheckTime": "20152016-01-15T10:36:40",
        "lastTransitionTime": "20152016-10-01T08:35:16",
        "message": "Ping completed: 5 sent, 0.0% loss, 0.6ms average round trip time",
        "name": "PING-Aetos",
        "status": "OK"
        }
    ]

...

By default, a filter created from a POST request persists for 5 minutes, and are designed to be used immediately after creation. The GET method can use the filter until expiry, after which a 410 Gone status code will be is returned.

Only the up.time Uptime Infrastructure Monitor user who created the filter will be is able to see and use it.