Public & meta ​

These endpoints do not require an API token.

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

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"
  }
}

Next ​