Check website readiness

GET

/api/v1/health

const url = 'https://api.inside.chat/api/v1/health?website_id=example';
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://api.inside.chat/api/v1/health?website_id=example' \
  --header 'Authorization: Bearer <token>'

Required scopes: health_read
Data access: –
MCP tool: health

Check enrollment readiness for one explicitly granted website. This does not contact the native cluster or prove live health.

Authorizations

installation_token
oauth_client_credentials
health_read

Parameters

Query Parameters

website_id

required

string

/^web_[0-9]{1,20}_[1-9][0-9]{0,18}$/

An explicitly granted website.

Responses

200

Authorized result. Projection depends on current scopes and data policy.

application/json

object

website_id

required

string

/^web_[0-9]{1,20}_[1-9][0-9]{0,18}$/

enrollment_ready

required

The website is enrolled with the Gateway.

boolean

live_health

required

This check never contacts the website cluster.

Allowed value: not_checked

Example

{
  "live_health": "not_checked"
}

400

Invalid, duplicate or unsupported request parameters.

401

Missing, expired or revoked installation credential.

404

Resource not found or not permitted by current authority.

422

The requested capability is not available for application installations.

429

Per-app quota exceeded.

Headers

Retry-After

integer

>= 1

503

Enrollment, native service or required authority is unavailable.