Ping Heartbeat

Request URL

GET /ping/heartbeat

Description

This endpoint can be used to check if the server is online and operating properly. It does not require a token and thus is publicly available.

Snippet Examples

javascript

const axios = require('axios');
const config = {
  method: 'GET',
  url: '${AMPLIFI_BASE_URL}/ping/heartbeat',
  headers: {

  },
};

let result;
try {
  result = await axios.request(config);
  if (result.status === 200) {
    console.log(JSON.stringify(result.data));
  }
} catch (err) {
  console.log({
    errCode: err.code,
    responseStatus: err.response && err.response.status,
    data: err.response && JSON.stringify(err.response.data)
  });
}

cURL

curl --location "AMPLIFI_BASE_URL/ping/heartbeat"  

Successful Response Examples

200 PING/HEARTBEAT SUCCESSFUL RESPONSE

HEADERS

Header	Value

REQUEST BODY

none

RESPONSE BODY

{
    "success": true,
    "dts": "2023-12-15T12:50:06.225Z"
}