Check node health

POST

/ping

const url = 'https://example.com/api/v0/ping';
const options = {method: 'POST', headers: {'X-Tenzir-Token': '<X-Tenzir-Token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v0/ping \
  --header 'X-Tenzir-Token: <X-Tenzir-Token>'

Checks whether the node can respond to authenticated API requests. The response includes the node version.

Authorizations

TenzirToken

Responses

200

The node is healthy.

application/json

object

version

required

The version of the responding node.

string

Example

{
  "version": "v2.3.0-rc3-32-g8529a6c43f"
}

401

The request is missing a valid authentication token.