Update an existing Check configuration

patch https://api.kolide.com/checks/{checkId}/configurations

Path Params

checkId

string

required

The checkId of the checkConfiguration

Body Params

paused

boolean

Whether this check is currently paused

block_auth_grace_period_days

integer

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

auth_check_run_shelf_life_seconds

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.

snooze_disallowed

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

options

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

remediation_strategy

string

The strategy used for remediating this check

Headers

x-kolide-api-version

string

required

Defaults to 2023-05-26

Specify the API version to be used

Responses

Response body

object

integer

The unique identifier for this check configuration

organization_id

integer

The ID of the organization to which this check belongs

check_id

integer

The ID of the check associated with this configuration

name

string

The name of the check associated with the check configuration

check_slug

string

A slugified version of the check name, used for URL paths

issue_title

string

The title of the issue associated with this check

options

json

Additional options for this check configuration. Options are specified on a per-check basis and can be viewed in the UI

use_custom_rationale_template

boolean

Whether a custom rationale template is used

use_custom_fix_instructions_template

boolean

Whether custom fix instructions are used

paused

boolean

Whether this check is currently paused

paused_by

string

The ID of the user who paused this check configuration

paused_at

date-time

The timestamp when this check configuration was paused

revision

string

The revision number of this check configuration

block_auth_grace_period_days

integer

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

auth_check_run_shelf_life_seconds

integer

Number of seconds a check run is valid for authentication

begins_blocking_on

date-time

Date when devices start being blocked if out of compliance

snooze_disallowed

boolean

Whether snoozing is disallowed for this check

customized_remediation_targeting

boolean

Whether remediation targeting is customized for this check

customized_run_targeting

boolean

Whether run targeting is customized for this check

remediation_strategy

string

The strategy used for remediating this check

block_immediately warn_then_block notify_only report_only

targeted_groups

array of strings

List of groups targeted by this check

targeted_groups

excluded_groups

array of strings

List of groups excluded from this check

excluded_groups

blocking_allowed_groups

array of strings

List of groups allowed to be blocked by this check

blocking_allowed_groups

blocking_excluded_groups

array of strings

List of groups excluded from being blocked by this check

blocking_excluded_groups

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.kolide.com/checks/checkId/configurations \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --header 'x-kolide-api-version: 2023-05-26'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated Check configuration

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