Skip to main content
GET
/
api
/
healthcheck
GET /api/healthcheck
curl --request GET \
  --url https://public-api.binibit.com/api/healthcheck

Documentation Index

Fetch the complete documentation index at: https://docs.binibit.com/llms.txt

Use this file to discover all available pages before exploring further.

Description

Returns the assembly name and version of the running API service. Use it as a liveness probe in your monitoring or CI.

Parameters

This endpoint takes no query parameters.

Response

A single JSON string.

Example request

curl https://public-api.binibit.com/api/healthcheck

Example response

"PublicApi v1.0.17.0"

Use as a liveness probe

# Returns 0 (success) when API is alive, non-zero on failure.
curl -fsS https://public-api.binibit.com/api/healthcheck > /dev/null
# Kubernetes-style probe
livenessProbe:
  httpGet:
    path: /api/healthcheck
    port: 443
    scheme: HTTPS
    host: public-api.binibit.com
  initialDelaySeconds: 10
  periodSeconds: 30

Notes

  • The version string format is <AssemblyName> v<MAJOR>.<MINOR>.<BUILD>.<REVISION>.
  • This endpoint is not rate-limited the same way as data endpoints — it exists specifically for high-frequency monitoring.
  • For full system status (per-component uptime, incidents), see the status page when available.