---
title: "This endpoint is used for getting a health monitoring rule template."
method: GET
path: "/healthmonitoring/ruletemplates/{id}"
tags: ["Monitoring and Alerting"]
---

# This endpoint is used for getting a health monitoring rule template.

`GET /healthmonitoring/ruletemplates/{id}`

## Request

- Base URL: `https://console.jumpcloud.com/api/v2`
- URL: `https://console.jumpcloud.com/api/v2/healthmonitoring/ruletemplates/{id}`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/docs/healthmonitoring/ruletemplates/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows you get a health monitoring rule template.

## Path parameters

- `id` string, byte, required

## Response `200`

A successful response.

- JumpcloudHealthmonitoringGetRuleTemplateResponse: GetRuleTemplateResponse is the response to the GetRuleTemplateRequest.
  - `template` JumpcloudHealthmonitoringRuleTemplate: RuleTemplate represents a rule template object.
    - `category` 'RULE_CATEGORY_UNSPECIFIED' | 'RULE_CATEGORY_DIRECTORY' | 'RULE_CATEGORY_SYSTEM' | 'RULE_CATEGORY_ADMIN' | 'RULE_CATEGORY_ACCESS' | 'RULE_CATEGORY_GENERAL' | 'RULE_CATEGORY_CUSTOM'
    - `configurations` JumpcloudHealthmonitoringRuleTemplateConfiguration[]
      - `defaultValue` object
      - `displayOptions` object
      - `displayType` 'DISPLAY_TYPE_UNSPECIFIED' | 'DISPLAY_TYPE_TEXT' | 'DISPLAY_TYPE_SELECT' | 'DISPLAY_TYPE_TEXTAREA' | 'DISPLAY_TYPE_CHECKBOX' | 'DISPLAY_TYPE_DATE' | 'DISPLAY_TYPE_EMAIL' | 'DISPLAY_TYPE_NUMBER' | 'DISPLAY_TYPE_RADIO' | 'DISPLAY_TYPE_SINGLELISTBOX' | 'DISPLAY_TYPE_DOUBLELISTBOX' | 'DISPLAY_TYPE_TABLE' | 'DISPLAY_TYPE_FILE' | 'DISPLAY_TYPE_SEGMENTEDBUTTON' | 'DISPLAY_TYPE_COPYWELL' | 'DISPLAY_TYPE_TIMEINPUT' | 'DISPLAY_TYPE_DATEPICKERRANGE' | 'DISPLAY_TYPE_MULTILIST' | 'DISPLAY_TYPE_INPUTREADONLY' | 'DISPLAY_TYPE_ICONSTATUS' | 'DISPLAY_TYPE_ITEMLIST' | 'DISPLAY_TYPE_EXISTING_VIOLATIONS'
      - `label` string
      - `name` string
      - `objectId` string, byte
      - `position` integer
      - `readOnly` boolean
      - `required` boolean
      - `tooltip` object
      - `validators` object
    - `createdAt` string, date-time
    - `description` string
    - `frequency` integer
    - `name` string
    - `objectId` string, byte
    - `osFamily` 'RULE_OS_FAMILY_UNSPECIFIED' | 'RULE_OS_FAMILY_ALL' | 'RULE_OS_FAMILY_WINDOWS' | 'RULE_OS_FAMILY_DARWIN' | 'RULE_OS_FAMILY_LINUX': RuleOsFamily specifies the OS family for a rule. Currently not being used. - RULE_OS_FAMILY_UNSPECIFIED: No OS family specified - RULE_OS_FAMILY_ALL: Rule applies to all supported OS families - RULE_OS_FAMILY_WINDOWS: Rule applies to windows OS family - RULE_OS_FAMILY_DARWIN: Rule applies to darwin OS family - RULE_OS_FAMILY_LINUX: Rule applies to linux OS family
    - `outputSchema` object
    - `ruleSubtype` string: Template variant paired with rule_type. For poll-based templates, pass this value with rule_type on rule create instead of template_object_id. Examples: certificate_expiry_detection, device_policy_detection.
    - `ruleType` 'RULE_TYPE_UNSPECIFIED' | 'RULE_TYPE_TEMPLATE_BASED' | 'RULE_TYPE_EVENT_FILTER_BASED' | 'RULE_TYPE_POLL_BASED': RuleType specifies the type of rule. - RULE_TYPE_UNSPECIFIED: No rule type specified. - RULE_TYPE_TEMPLATE_BASED: Template-based rules; omit rule_subtype and set template_object_id. - RULE_TYPE_EVENT_FILTER_BASED: Insights rules; omit rule_subtype and set event_filters. - RULE_TYPE_POLL_BASED: Poll-based rules; set rule_subtype (e.g. certificate_expiry_detection) or template_object_id.
    - `siRequired` boolean
    - `status` string
    - `systemBindingRequired` boolean
    - `type` string
    - `unrestricted` boolean
    - `updatedAt` string, date-time
    - `version` string

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-api-2/revisions/3f09fe63caaa?raw)