Check server health

GET

/health

const url = 'https://example.com/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://example.com/health

Responses

200

Successful Response

application/json

HealthResponse

object

custom_domains_error

Any of:

string
null

string

Allowed value: routers_unmanaged

status

required

Status

degraded reports a problem that does not stop Buzz from serving.

string

Allowed values: ok degraded

wildcard_certificate

Any of:

CertificateHealthResponse
null

CertificateHealthResponse

object

checked_at

required

Checked At

string format: date-time

detail

required

Any of:

string
null

string

expires_at

required

Any of:

string
null

string format: date-time

required

boolean

reason

required

Any of:

string
null

string

Allowed values: proxy_unreachable certificate_invalid certificate_expiring

wildcard_certificate_error

Any of:

string
null

string

Allowed values: not_configured issuance_failed storage_failed publish_failed check_failed

Example

{
  "custom_domains_error": "routers_unmanaged",
  "status": "ok",
  "wildcard_certificate": {
    "reason": "proxy_unreachable"
  },
  "wildcard_certificate_error": "not_configured"
}