Fetch information for a specific Check

200

A Check is a test that Kolide runs on a device on a regular cadence
which typically produces a passing or failing result.

Response body

object

string

The canonical identifier for this check

name

string

The short description of the state the check is meant to enforce

slug

string

The unique, stable and human-readable identifier for this check

compatible_platforms

array of strings

An array of device platforms this check can run on. The platform possibilities are:

linux: this check can run on all linux derivations
windows: this check can run on all windows devices
darwin: this check can run on all versions of macOS

The compatible platforms determine the default targeting if no custom targeting is configured

compatible_platforms

description

string

Longer-form description of the check's purpose and operation

topics

array of strings

A list of Kolide-set topics associated with the Check

topics

osquery_sql_template

string

The templated SQL associated with a custom check query that will be run on devices to determine the custom check's status. This SQL may contain liquid variables. This field will be blank if the check is not a custom check. You can learn more about writing your own checks at https://www.kolide.com/docs/admins/checks.

issue_title

string

The title of the issue that will be created if the check fails

fix_instructions_template

string

The markdown-formatted template for the fix instructions that will be provided to the user to fix the issue. This may contain liquid variables. You can learn more about customizing fix instructions at https://www.kolide.com/docs/admins/checks#customizing-end-user-fix-instructions.

rationale_template

string

The markdown-formatted template for the rationale that will be provided to the user when the check fails. This may contain liquid variables.

check_tags

array of objects

A list of Team-set tags associated with the Check

check_tags

object

string

The canonical identifier for this check tag

name

string

The short name of the check tag

description

string

The description of the check tag

color

string

The rgba color value for this tag

blocks_auth_configuration

object

Object describing the authentication-blocking configuration of the check

blocking_enabled

boolean

Whether or not an issue for this check will block device trust authentication

grace_period_days

integer

The number of days that a device is allowed to be failing the check before it will be blocked

blocking_group_names

array of strings

The names of the groups that define which devices will be blocked by this check. See also blocking_exempt_group_names, as membership in an excluded group will exempt a device from being blocked by this check.

blocking_group_names

blocking_exempt_group_names

array of strings

The names of the Groups that are exempt from being blocked by this check

blocking_exempt_group_names

targeting_configuration

object

Object describing the device targeting configuration of the check

excluded_groups

array of strings

A list of names for the groups whose device members are excluded from being targets for this check

excluded_groups

targeted_groups

array of strings

The names of the groups that define which devices will be targeted by this check. See also excluded_groups, as membership in an excluded group will exempt a device from being targeted by this check.

targeted_groups

kolide_provided

boolean

Kolide provided checks are created and maintained by the Kolide team. This field is false for user-created custom checks.

200A Check is a test that Kolide runs on a device on a regular cadence which typically produces a passing or failing result.

401An 'unauthorized' response may occur for features restricted by or unavailable to your organization

403A 'forbidden' response may occur if the API key does not have necessary permissions to perform certain actions