GuidesAPI Reference
Log In
API Reference

Create a custom check draft

post
https://api.kolide.com/custom_check_drafts

Creates a custom check draft. Pass custom_check_id to start editing
an existing custom check (its current state is imported into the
draft); omit it to create a brand-new draft. Edits are staged on the
draft and only applied to a check when published.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

ID of an existing custom check to edit. When present, the check's state is imported into the draft. Global (non-custom) checks are rejected.

string

The display name of the check

string
enum

osquery or external

Allowed:
string
enum

devices or people (external only; osquery is always devices)

Allowed:
string

Longer-form description of the check

string

Title of the issue when the check fails

string

Privacy center copy (may include Liquid)

string

The osquery SQL for an osquery check (must contain KOLIDE_CHECK_STATUS)

string

Liquid/Markdown template for end-user rationale

string

Liquid/Markdown template for remediation steps

boolean

When true, primary_key_column must be set

string

Column used as the stable primary key when requires_primary_key is true

platforms
array of strings

Device platforms this check targets: any of darwin, windows, linux (devices checks only). Accepts an array (['darwin','linux']) or a comma-separated string ('darwin, linux').

platforms
json

Example result rows keyed by example name, e.g. {"Example": [{"col": "val", "KOLIDE_CHECK_STATUS": "FAIL"}]}. Each entry is stored as a data example.

Headers
string
Defaults to 2026-04-07

Specify the API version to be used

Responses

Updated 5 days ago

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

Updated 5 days ago

Did this page help you?