Access Certification21

Access Requests20

Access Risk Settings2

Active Directory9

Administrators4

Agent Groups5

Agents11

Aggregated Policy Stats1

App Catalog2

Apple MDM21

Application Templates2

Applications13

Assets27

Authentication Policies8

Bulk Job Requests9

Command Results3

Command Triggers1

Commands10

Custom Emails5

Directories1

Duo9

Email Subscriptions2

FeatureTrials1

G Suite15

GCEP4

Google EMM21

Graph119

Groups1

Identity Risk10

IP Lists6

LDAP Servers3

Logos1

mdm24

Microsoft MDM1

Monitoring and Alerting19

get/api/v2/healthmonitoring/rulesThis endpoint is used for listing the rules of health monitoring.
post/api/v2/healthmonitoring/rulesThis endpoint is used for creating the rules.
get/api/v2/healthmonitoring/rules/{id}This endpoint is used for getting a health monitoring rule.
delete/api/v2/healthmonitoring/rules/{id}This endpoint is used to delete health monitoring rules.
patch/api/v2/healthmonitoring/rules/{id}This endpoint is used for updating the rules.
get/api/v2/healthmonitoring/ruletemplatesThis endpoint is used for listing the rules of health monitoring.
get/api/v2/healthmonitoring/ruletemplates/{id}This endpoint is used for getting a health monitoring rule template.
get/api/v2/alertsThis endpoint provides details of all alerts.
get/api/v2/alerts/{id}This endpoint provides details of an alert.
delete/api/v2/alerts/{id}This endpoint is used to delete an alert.
get/api/v2/alerts/{id}/occurrencesThis endpoint is used to list one or more occurrences for an Alert.
post/api/v2/alerts/{id}/statusThis endpoint is used for updating the status of an alert.
get/api/v2/alerts-statsThis endpoint provides alert statistics based on status and severity
get/api/v2/healthmonitoring/rules-statsThis endpoint is getting rules stats.
patch/api/v2/healthmonitoring/rules/{id}/statusThis endpoint is used for updating the status of a rule.
post/api/v2/alerts/bulk-deleteThis endpoint is used for performing bulk delete operations on alerts.
post/api/v2/alerts/bulk-updateThis endpoint is used for performing bulk update operations on alerts.
get/api/v2/alerts/{alertObjectId}/notesThis endpoint provides all notes for an alert.
post/api/v2/alerts/{alertObjectId}/notesThis endpoint is used for adding notes to alerts.

Notifications Channels6

Object Storage2

Office 36513

Organization Feature Settings2

Organizations4

Password Manager40

Password Policy10

Password Vault69

Policies9

Policy Groups5

Policytemplates2

Privileged Access25

Providers82

Push Verification2

Radius Servers5

Reports25

Roles5

SaaS App Management13

Samba Domains5

Sample Data1

Saved Views6

Scope Groups1

Search8

Service Accounts6

Slack Notifications1

Software Apps9

Subscriptions1

System Groups7

System Insights60

Systems14

Systems Organization Settings8

Systemusers18

Translation Rules7

User Groups7

Users7

Webhook Notifications1

Webhook Notifications Channels1

Workday Import9

Workflows10

Monitoring and Alerting

This endpoint is used for updating the status of a rule.

This endpoint allows you to update the status of a health monitoring rule.

patch/api/v2/healthmonitoring/rules/{id}/status

Request

Base URL
https://console.jumpcloud.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/docs/api/v2/healthmonitoring/rules/:id/status/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring byte required

Request body

status'RULE_STATUS_UNSPECIFIED' | 'RULE_STATUS_ENABLED' | 'RULE_STATUS_DISABLED'

RuleStatus specifies the status of a rule. The status of the rule which can be either enabled or disabled. The rule is processed only in an enabled state.

RULE_STATUS_UNSPECIFIED: No status specified
RULE_STATUS_ENABLED: rule is enabled
RULE_STATUS_DISABLED: rule is disabled

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.