v1

latestOpenAPI 3.0.02026-07-14512083.9 KB

Fetch information for a specific Check

get/checks/{id}

Path parameters

idstring required

The id of the check

Response

Information about one Check

idstring

The canonical identifier for this Check

failing_device_countinteger

The number of devices in your organization failing the Check

display_namestring

The display name of the Check

namestring

The name of the Check. DEPRECATED (Use display_name instead)

descriptionstring

A description of the purpose and rationale of the Check

compatibilityinteger[]

Operating system platforms that this Check is compatible with

topicsinteger[]

A list of Kolide-set topics associated with the Check

tagsinteger[]

A list of Team-set tag names associated with the check. DEPRECATED: use check_tags attribute instead for more complete tag information

check_tagsinteger[]

A list of Team-set tags associated with the Check

notification_strategystring

Describes how notifications are handled when an issue occurs for the Check

notification_grace_periodinteger

The number of days a user is given to resolve Issues with this Check before they are notified. The time period starts when the Issue is detected by Kolide. This field is only relevant if the Check is configured to notify end users.