Skip to main content
PUT
Update a check

Path Parameters

checkId
string
required

The ID of the check

Query Parameters

deleteHistory
enum<string>
default:false

When true, also delete historical check results on rule change. Current results are always deleted. Defaults to false.

Available options:
true,
false

Body

application/json

A check definition. Supports three types based on fields provided: rule-based (include rule field), manual (set type to manual), or external (omit both rule and type).

id
string
required
ownerEntityRef
string
name
string
Required string length: 1 - 100
description
string
filter
object
exclude
object
rule
object

Fact checker rule (required for rule-based checks, omit for manual/external)

applicable
object

Applicability condition

type
enum<string>

Check type. Set to 'manual' for manual checks, 'default' or omit for rule-based checks.

Available options:
default,
manual
warning
boolean
passedMessage
string
Minimum string length: 1
failedMessage
string
Minimum string length: 1
notApplicableMessage
string
Minimum string length: 1
pathResolver
string
skillEntityRef
string

Response

OK

check
object
required