Core health

GET

/health

const url = 'https://my-instance.example.com/health';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://my-instance.example.com/health \
  --header 'Authorization: Bearer <token>'

Core-owned health. Reports the composed provider ids and the running @notewright/core version (used by the CLI to detect version skew).

Authorizations

bearerAuth

Responses

200

Health payload.

application/json

object

boolean

version

string

notes

string

followUp

string

Example

{
  "ok": true,
  "version": "1.2.3",
  "notes": "granola",
  "followUp": "linear"
}

401

The bearer token is missing or wrong.

application/json

object

error

required

string

code

string

Example

{
  "error": "Unauthorized"
}