latestOpenAPI 3.0.12026-07-31240345599.7 KB
ed65f017bcb8
Heartbeats
Ping Heartbeat
Pings the heartbeat with given name. Heartbeat ping requests processed asynchronously, it does not check if the heartbeat exists or not before responding. Please note that receiving a PONG response does not necessarily mean that the heartbeat exists.
get/api/{cloudId}/v1/teams/{teamId}/heartbeats/ping
Path parameters
teamIdstring required
Identifier of the heartbeat owning team.
Query parameters
namestring required
Name of the heartbeat for identification.
Response
Returned if the request is successful.
Example response
{
"message": "PONG - Heartbeat received"
}