Rotate heartbeat ping URL

POST

metrics

{id}

heartbeat

rotate

Issue a new heartbeat ping URL (the old one stops working)

curl --request POST \
  --url https://use.observer/api/v1/metrics/{id}/heartbeat/rotate \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://use.observer/api/v1/metrics/{id}/heartbeat/rotate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "metric_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "period_seconds": 123,
  "grace_seconds": 123,
  "state": "waiting",
  "pings": [
    {
      "kind": "success",
      "received_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "exit_code": 123,
      "message": "<string>",
      "via": "direct"
    }
  ],
  "max_runtime_seconds": 123,
  "status": "healthy",
  "due_at": "2023-11-07T05:31:56Z",
  "last_ping_at": "2023-11-07T05:31:56Z",
  "last_ping_kind": "success",
  "last_success_at": "2023-11-07T05:31:56Z",
  "last_start_at": "2023-11-07T05:31:56Z",
  "last_fail_at": "2023-11-07T05:31:56Z",
  "last_exit_code": 123,
  "last_duration_ms": 123,
  "token_rotated_at": "2023-11-07T05:31:56Z",
  "ping_url": "<string>"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

Authorizations

Authorization

string

header

required

An organization API key (obs_pub_…) sent as Authorization: Bearer <key>. Each key carries scopes; an endpoint lists the scope it needs.

Path Parameters

string<uuid>

required

Metric id.

Response

ok, body includes the new ping_url

metric_id

string<uuid>

required

period_seconds

integer

required

grace_seconds

integer

required

state

enum<string>

required

Evaluator phase. waiting = no ping received yet (no status is written).

Available options:

waiting,

up,

running,

late,

failed,

runtime_exceeded

pings

object[]

required

Show child attributes

max_runtime_seconds

integer | null

status

enum<string> | null

Available options:

healthy,

degraded,

unhealthy,

null

due_at

string<date-time> | null

When the check goes late without a success ping.

last_ping_at

string<date-time> | null

last_ping_kind

enum<string> | null

Available options:

success,

start,

fail,

null

last_success_at

string<date-time> | null

last_start_at

string<date-time> | null

last_fail_at

string<date-time> | null

last_exit_code

integer | null

last_duration_ms

integer | null

token_rotated_at

string<date-time> | null

ping_url

string<uri>

The check's ping URL. Present only for keys with write:metrics or write:config (a config writer creates heartbeat checks and needs the URL to wire up the job): anyone holding it can record pings.

Issue a new heartbeat ping URL (the old one stops working)

curl --request POST \
  --url https://use.observer/api/v1/metrics/{id}/heartbeat/rotate \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://use.observer/api/v1/metrics/{id}/heartbeat/rotate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "metric_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "period_seconds": 123,
  "grace_seconds": 123,
  "state": "waiting",
  "pings": [
    {
      "kind": "success",
      "received_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "exit_code": 123,
      "message": "<string>",
      "via": "direct"
    }
  ],
  "max_runtime_seconds": 123,
  "status": "healthy",
  "due_at": "2023-11-07T05:31:56Z",
  "last_ping_at": "2023-11-07T05:31:56Z",
  "last_ping_kind": "success",
  "last_success_at": "2023-11-07T05:31:56Z",
  "last_start_at": "2023-11-07T05:31:56Z",
  "last_fail_at": "2023-11-07T05:31:56Z",
  "last_exit_code": 123,
  "last_duration_ms": 123,
  "token_rotated_at": "2023-11-07T05:31:56Z",
  "ping_url": "<string>"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

Getting started

Account

Status pages

Services

Metrics

SLOs

SLA statements

Incidents

Maintenances

Config as code

Agents

Change events

Rotate heartbeat ping URL

Authorizations

Path Parameters

Response