Skip to content
HeadlessWP Pro

Health

id: core-health owner: core method: GET path: /wp-json/headlesswp/v1/health title: Health usedBySite: false

GET /wp-json/headlesswp/v1/health

Returns service status and environment-safe diagnostics for the HWP plugin.

Auth + CSRF

  • Auth: public
  • Proxy nonce required: no
  • CSRF: exempt

Request schema

No request body.

Response schema

{
  "data": {
    "status": "ok",
    "version": "0.0.0",
    "env": "development",
    "wpVersion": "6.8.0",
    "phpVersion": "8.2.0",
    "dependencies": {
      "woocommerce": "active|missing",
      "restrictContentPro": "active|missing",
      "affiliateWp": "active|missing"
    },
    "buildId": "dev",
    "buildFlavor": "full",
    "nonceBootstrapStrategy": "wp_validate_auth_cookie_globals_v1"
  },
  "meta": {
    "correlationId": "string-or-null",
    "correlation_id": "string-or-null",
    "request_id": "string-or-null",
    "timestamp": "2024-01-01T00:00:00Z"
  }
}

Notes:

  • buildId, buildFlavor, and nonceBootstrapStrategy are additive fingerprint fields intended for deployment and behavior diagnostics.
  • The endpoint does not return request cookies, user identifiers, nonces, or tokens.

Error codes

  • METHOD_NOT_ALLOWED (405) for unsupported methods such as POST.
  • Otherwise, WordPress standard REST error envelopes may apply.