This endpoint is used for listing the rules of health monitoring.
This endpoint allows you list health monitoring rules.
Request
- Base URLhttps://console.jumpcloud.com/api/v2
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
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
The fields on the items listed to return.
The offset into the records to return.
An optional comma separated field names used to sort the collection. Default sort is ascending, prefix with - to sort descending.
The number of rules to return at once. If the number of rules returned is less than limit there are no more rules to fetch. If the number of rules returned is equal to limit there may be more rules to fetch. Increment skip by limit to get the next set of rules.
- RULE_LABEL_UNSPECIFIED: No label specified; defaults to admin behaviour.
- RULE_LABEL_ADMIN: Rule was created through the Admin UI.
- RULE_LABEL_WORKFLOW: Rule was created by the Workflow service.
Response
A successful response.
Changes
No recorded changes to this operation across all 1 revision of this API.