GuidesAPI Reference
Log In
API Reference

Create a new External check run

post
https://api.kolide.com/checks//runs
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The check ID of the external check run

Body Params
integer

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

integer

The ID of the person. Must pass exactly one of device_id, person_id, or 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.

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
string
Defaults to 2026-04-07

Specify the API version to be used

Responses

Updated 2 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago