Create a new External check run

post

https://api.kolide.com/checks/{checkId}/runs

Path Params

checkId

string

required

The check ID of the external check run

Body Params

device_id

integer

The ID of the device. Must pass exactly one of device_id, person_id, or person_email.

person_id

integer

The ID of the person. Must pass exactly one of device_id, person_id, or person_email.

person_email

string

The email of the person. Falls back to matching an identity email if no person matches directly. Must pass exactly one of device_id, person_id, or person_email.

check_data

json

Data for the check result. Must include a KOLIDE_CHECK_STATUS attribute with a value matching one of FAIL, PASS, UNKNOWN, INAPPLICABLE, ERROR. May optionally include additional key-value pairs as extra metadata. May contain one element, or many elements in an array.

Headers

x-kolide-api-version

string

Defaults to 2023-05-26

Specify the API version to be used

Responses

200The newly created External check run

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