Hoody Cron API

The Cron service provides health monitoring and machine-readable API documentation. Use these endpoints to verify the service is running, retrieve its OpenAPI specification in JSON or YAML format, and diagnose configuration issues.

---

Service health

GET /health

Returns the operational status of the Cron service along with runtime metadata such as process ID, startup time, IP address, and memory usage.

This endpoint takes no parameters.

Response 200

Service is healthy.

{
  "status": "ok",
  "service": "cron",
  "started": "2026-01-15T08:30:00.000Z",
  "pid": 4281,
  "ip": "10.0.0.42",
  "built": "2026-01-14T12:00:00.000Z",
  "fds": 16,
  "memory": {
    "rss": 67108864,
    "heap": 33554432
  },
  "user_agent": "Hoody-HealthCheck/1.0"
}

Response fields:

Field	Type	Description
status	string	Current service health status
service	string	Service name
started	string	ISO 8601 timestamp of when the service started
pid	integer	Process ID of the running service
ip	string	IP address the service is bound to
built	string | null	ISO 8601 build timestamp, or null if unknown
fds	integer | null	Number of open file descriptors, or null if unavailable
memory	object | null	Memory usage details (RSS and optional heap), or null
memory.rss	integer	Resident set size in bytes
memory.heap	integer | null	Heap usage in bytes, or null
user_agent	string | null	User agent string from the request, or null

Note

Use this endpoint for liveness probes and load balancer health checks. The response is lightweight and has no side effects.

SDK usage:

const result = await client.cron.health.check();

---

OpenAPI specification

GET /openapi.json

Returns the full OpenAPI 3.x specification for the Cron service as a JSON document. Useful for generating client libraries, importing into tools like Postman or Insomnia, or building documentation.

This endpoint takes no parameters.

Response 200

OpenAPI JSON document.

{
  "openapi": "3.0.3",
  "info": {
    "title": "Hoody Cron API",
    "version": "1.0.0",
    "description": "Scheduled task management for the Hoody platform"
  },
  "servers": [
    {
      "url": "https://api.hoody.com/api/cron"
    }
  ],
  "paths": {
    "/health": {
      "get": {
        "summary": "Service health check",
        "responses": {
          "200": {
            "description": "Service is healthy"
          }
        }
      }
    },
    "/openapi.json": {
      "get": {
        "summary": "OpenAPI JSON",
        "responses": {
          "200": {
            "description": "OpenAPI JSON"
          }
        }
      }
    },
    "/openapi.yaml": {
      "get": {
        "summary": "OpenAPI YAML",
        "responses": {
          "200": {
            "description": "OpenAPI YAML"
          },
          "500": {
            "description": "Render error"
          }
        }
      }
    }
  }
}

SDK usage:

const spec = await client.cron.system.getOpenApiJson();

---

GET /openapi.yaml

Returns the same OpenAPI specification as /openapi.json, serialized as YAML. Prefer this endpoint when piping the spec into tools that accept YAML natively.

This endpoint takes no parameters.

Response 200

OpenAPI YAML document.

openapi: 3.0.3
info:
  title: Hoody Cron API
  version: 1.0.0
  description: Scheduled task management for the Hoody platform
servers:
  - url: https://api.hoody.com/api/cron
paths:
  /health:
    get:
      summary: Service health check
      responses:
        "200":
          description: Service is healthy
  /openapi.json:
    get:
      summary: OpenAPI JSON
      responses:
        "200":
          description: OpenAPI JSON
  /openapi.yaml:
    get:
      summary: OpenAPI YAML
      responses:
        "200":
          description: OpenAPI YAML
        "500":
          description: Render error

Response 500

The server failed to render the OpenAPI specification as YAML.

{
  "code": "BACKEND_ERROR",
  "message": "Internal server error",
  "details": "Unable to serialize OpenAPI document to YAML"
}

Error Code	Title	Description	Resolution
BACKEND_ERROR	Backend error	Failed to read or write system crontab	Check crontab availability and permissions

SDK usage:

const spec = await client.cron.system.getOpenApiYaml();