Sign in
Objects

Create business service check

Create new check in given business service or business service prototype. Checks created in a prototype are propagated to all business services created from it. Omitted fields get default values (type "object", description "Unnamed", no related object, default threshold). Requires modify access to the object.

post/v1/objects/{object-id}/business-service-checks

Request body

type'object' | 'dci' | 'script'
descriptionstring
relatedObjectIdinteger
relatedDciIdinteger
statusThresholdinteger
scriptstring nullable

NXSL script source; compiled on save when check type is script, compilation errors are reported as 400

Response

Check created.

idinteger
serviceIdinteger

ID of business service or prototype owning this check

type'object' | 'dci' | 'script' | 'none'
descriptionstring
relatedObjectIdinteger

Object whose status is checked (object and DCI checks); for script checks, object passed to the script as $object (0 if none)

relatedDciIdinteger

DCI whose threshold state is checked (DCI checks)

statusThresholdinteger

Object or DCI status at which check fails; 0 means use server default

scriptstring nullable

NXSL script source (script checks)

statusinteger

Current check status (0 = normal, 2 = minor, 4 = critical)

failureReasonstring

Reason of last failure

prototypeServiceIdinteger

ID of prototype this check was created from (equals serviceId for auto-bound checks), 0 for manually created checks

prototypeCheckIdinteger

ID of prototype check this check was created from, 0 if none

autoCreatedboolean

True if check was created automatically (from prototype or by auto-binding) and cannot be modified

Changes

Changed in 1 of the 128 revisions of this API.1