Skip to content

Run a builtin check ad hoc

POST
/api/v1/check-commands:test
curl --request POST \
--url https://example.com/api/v1/check-commands:test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "address": "example", "args": [ "example" ], "builtin": "example" }'
Media typeapplication/json
object
address
required
string
args
Array<string>
builtin
required
string
Examplegenerated
{
"address": "example",
"args": [
"example"
],
"builtin": "example"
}

OK

Media typeapplication/json
object
label
required
string
output
required
string
perfdata
string
state
required
integer
tookMs
required
integer
Examplegenerated
{
"label": "example",
"output": "example",
"perfdata": "example",
"state": 1,
"tookMs": 1
}

Problem Details (RFC 9457)

Media typeapplication/problem+json
object
code
required
string
detail
string
instance
string
status
required
integer
title
required
string
type
required
string
Examplegenerated
{
"code": "example",
"detail": "example",
"instance": "example",
"status": 1,
"title": "example",
"type": "example"
}