AvenPing API health and version endpoints ​

These endpoints do not require an API token. Use them to confirm routing (GET /v2/health) and read build info (GET /v2/version).

Also read: HTTP API v2 Overview for conventions and global response shapes.

Prerequisites ​

  • Network access to https://api.avenping.com
  • No API token is required for these routes
  • A token is required only when you continue to GET /v2/me

Step-by-step ​

  1. Call GET /v2/health
    curl -sS https://api.avenping.com/v2/health should return { "success": true, "data": { "ok": true } }.

  2. Call GET /v2/version
    GET /v2/version returns package name, version (from the deployed package when available), and nodeEnv.

  3. Optionally request JSON from GET /
    Use GET /?format=json or send Accept: application/json. Otherwise the root returns a short HTML landing page.

  4. Authenticate for protected routes
    After health checks pass, send a Bearer or X-API-Token and call GET /v2/me. Every other /v2/* route requires a token, an active plan, and Premium or Enterprise.

Root (non-versioned) ​

GET / ​

VariantBehavior
HTMLDefault: short landing page with links to /v2/health and /v2/version.
JSONGET /?format=json or Accept: application/json

Example request (JSON):

bash
curl -sS "https://api.avenping.com/?format=json"

Response 200 (JSON):

json
{
  "success": true,
  "data": {
    "name": "avenping-api",
    "versions": ["v2"],
    "docs": {
      "health": "/v2/health",
      "version": "/v2/version",
      "me": "/v2/me"
    }
  }
}

GET /v2/health ​

Example request:

bash
curl -sS "https://api.avenping.com/v2/health"

Response 200:

json
{
  "success": true,
  "data": { "ok": true }
}

GET /v2/version ​

Example request:

bash
curl -sS "https://api.avenping.com/v2/version"

Response 200 — version comes from the deployed package when available.

json
{
  "success": true,
  "data": {
    "name": "avenping-api",
    "version": "1.0.0",
    "nodeEnv": "production"
  }
}

FAQ ​

Do I need a token for health checks?

No. GET /v2/health, GET /v2/version, and GET / do not require authentication.

How do I get JSON from GET /?

Use GET /?format=json or send Accept: application/json. Otherwise the root returns a short HTML landing page.

Are these the only unauthenticated routes?

Yes for v2. Every other /v2/* route needs a valid token, an active plan, and Premium or Enterprise. See Authentication.