API Reference

Update an existing Check configuration

put
https://api.kolide.com/checks//configurations
Path Params
string
required

The check ID of the check configuration

Body Params
boolean

Whether this check is currently paused

integer

Number of days a device is allowed to be out of compliance before blocking

integer

Number of seconds a check result is considered valid for authentication. If a check result is older than this value at authentication time, it will be re-run during the authentication process.

boolean

Whether users are allowed to snooze this check

targeted_groups
array of strings

List of groups targeted by this check. This field is a combination of group IDs and platform names. For platform names, use 'macos', 'windows', or 'linux'.

targeted_groups
excluded_groups
array of strings

List of groups excluded from this check. This field is a combination of group IDs and platform names. For platform names, use 'macos', 'windows', or 'linux'.

excluded_groups
blocking_allowed_groups
array of strings

List of groups allowed to be blocked by this check. This field is a combination of group IDs and platform names. For platform names, use 'macos', 'windows', or 'linux'.

blocking_allowed_groups
blocking_excluded_groups
array of strings

List of groups excluded from being blocked by this check. This field is a combination of group IDs and platform names. For platform names, use 'macos', 'windows', or 'linux'.

blocking_excluded_groups
json

Additional options for this check configuration. Changes to this field will overwrite previous options and any fields not specified here will be deleted. Options are specified on a per-check basis and can be viewed in the UI

string
enum

The strategy used for remediating this check

Allowed:
Headers
string
Defaults to 2023-05-26

Specify the API version to be used

Responses

Updated over 1 year ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 1 year ago