Skip to content
NorthplaneNorthplane

Create/update heartbeat definition

POST
/api/v1/heartbeats
curl --request POST \
  --url https://example.com/api/v1/heartbeats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expectEvery": 1, "grace": 1, "labels": { "additionalProperty": "example" }, "name": "example", "severity": "example" }'

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
expectEvery
required
integer
grace
integer
labels
object
key
additional properties
string
name
required
string
severity
string
Examplegenerated
{
  "expectEvery": 1,
  "grace": 1,
  "labels": {
    "additionalProperty": "example"
  },
  "name": "example",
  "severity": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
createdAt
required
string format: date-time
expectEvery
required
integer
grace
integer
id
required
string
labels
object
key
additional properties
string
lastBeat
string format: date-time
missing
required
boolean
name
required
string
severity
required
string
tenantId
required
string
updatedAt
required
string format: date-time
version
required
integer
Examplegenerated
{
  "createdAt": "2026-04-15T12:00:00Z",
  "expectEvery": 1,
  "grace": 1,
  "id": "example",
  "labels": {
    "additionalProperty": "example"
  },
  "lastBeat": "2026-04-15T12:00:00Z",
  "missing": true,
  "name": "example",
  "severity": "example",
  "tenantId": "example",
  "updatedAt": "2026-04-15T12:00:00Z",
  "version": 1
}

default

Section titled “default”

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"
}