You can perform a filter on objects for use with the
GET method to reduce API calls and improve performance.
To perform a filter, use the
POST method to indicate the object type (the elements, groups, and monitors endpoints), and provide JSON-compliant object IDs:
The response includes a newly created filter ID for the collection of endpoints:
You can also return an array of element statuses:
For "monitor" and "group" object types, the IDs provided in the
POST request correspond to the id field for the objects filtered. The object ID provided must match the object type declared in the request.
Similarly, element IDs can be provided for "element" object types:
However, for this object type, groups can also be provided. This can be helpful in cases where you want to output element listings, but are using groups as a way to declare the elements. In the request, the group
id field is denoted as
With this call, both elements and groups can also be filtered together:
Monitors Filter Example
Elements Filter Example
Groups Filter Example
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 is returned.
Only the Uptime Infrastructure Monitor user who created the filter is able to see and use it.