Heartbeats

Create a new heartbeat.

Required permission: heartbeats_write

post/v3/heartbeats/{logId}/{id}

Request

Base URL
https://api.elmah.io (the document declares no server; this is the origin it was published from)
Auth
API key in query parameter api_key
TypeScript
https://skmtc.dev/elmah/apis/elmah-io-api/docs/v3/heartbeats/:logId/:id/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The ID of the heartbeat check.

logIdstring required

The ID of the log containing the heartbeat check.

Request body

resultstring

The result of this heartbeat. Can be "Healthy, "Degraded", or "Unhealthy". Defaults to "Healthy"

reasonstring

If result is "Degraded" or "Unhealthy" you can use this property to specify why.

applicationstring

Optional string to identify which application logged this message. You can use this if you have multiple applications and services logging to the same log. If not set, the application name "Heartbeats" will be set on all log messages generated from this heartbeat.

versionstring

Optional string to identify which version of your application logged this message. If not specified, any errors, warnings, or information messages will get the newest version number created through deployment tracking as with normal log messages.

tookinteger

Optional long for specifying how many milliseconds it took to execute the task resulting in this heartbeat. This can be used to get a better overview of how long a scheduled task or service is running or to figure out if the grace period should be increased.

Response

Heartbeat was created.

Changes

No recorded changes to this operation across all 2 revisions of this API.