Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Service Checks

Submit a Service Check

Submit a list of Service Checks.

Notes:

  • A valid API key is required.
  • Service checks can be submitted up to 10 minutes in the past.
post/api/v1/check_run

Request body

checkstring required

The check.

host_namestring required

The host name correlated with the check.

messagestring

Message containing check status.

status0 | 1 | 2 | 3 required

The status of a service check. Set to 0 for OK, 1 for warning, 2 for critical, and 3 for unknown.

tagsstring[] required

Tags related to a check.

timestampinteger

Time of check.

Example request

[
  {
    "check": "app.ok",
    "host_name": "app.host1",
    "message": "app is running",
    "tags": [
      "environment:test"
    ]
  }
]

Response

Payload accepted