Check API health

GET

/health

const url = 'https://api.braiv.co/v1/health';
const options = {method: 'GET'};

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

curl --request GET \
  --url https://api.braiv.co/v1/health

Returns the deployed API version. No API key is needed.

Responses

200

The API is available.

application/json

object

required

Whether the HTTP service is running.

boolean

version

required

Deployed public API version.

string

Example

{
  "ok": true,
  "version": "v1"
}