Monitoring and Alerting
This endpoint provides details of all alerts.
This endpoint allows you to get all alerts.
get/api/v2/alerts
Request
- Base URLhttps://console.jumpcloud.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
filterstring[]
A filter to apply to the query.
**Filter structure**: `<field>:<operator>:<value>`.
**field** = Populate with a valid field from an endpoint response.
**operator** = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in.
**value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards.
**Example** `GET /api/v2/groups?filter=name:eq:Test+Group`
fieldsstring[]
The fields on the items listed to return.
skipstring int64
The offset into the records to return.
sortstring[]
An optional comma separated field names used to sort the collection. Default sort is ascending, prefix with - to sort descending.
limitstring int64
The number of alerts to return at once. If the number of alerts returned is less than limit there are no more alerts to fetch. If the number of alerts returned is equal to limit there may be more alerts to fetch. Increment skip by limit to get the next set of alerts.
Response
A successful response.
Changes
No recorded changes to this operation across all 1 revision of this API.