# System Monitoring

**Page:** api/files/monitoring

[Download Raw Markdown](./api/files/monitoring.md)

---

{/* AUTO-GENERATED — Do not edit manually. Regenerate with: npm run docs:api:generate */}



## Service health check

Use this endpoint to verify that the Hoody Files service is running and to inspect runtime metadata such as build timestamp, process ID, and memory usage. It is intended for liveness/readiness probes and operational diagnostics.

### `GET /api/v1/files/health`

Returns service identity, build and start timestamps, resource usage, and caller metadata. This endpoint takes no parameters.

#### Response — `200`

A successful response indicates the service is healthy and reachable.

```json
{
  "status": "ok",
  "service": "hoody-files",
  "built": "2024-11-18T09:32:11.000Z",
  "started": "2024-11-20T14:05:47.000Z",
  "memory": {
    "heap": null,
    "rss": 87359488
  },
  "fds": 42,
  "pid": 17,
  "ip": "10.0.12.84",
  "userAgent": "curl/8.4.0"
}
```

| Field | Type | Description |
|-------|------|-------------|
| `status` | string | Service health status. Expected value: `ok`. |
| `service` | string | Service identifier (e.g. `hoody-files`). |
| `built` | string \| null | ISO 8601 build timestamp. |
| `started` | string | ISO 8601 timestamp marking when the service process started. |
| `memory` | object | Resource usage snapshot. |
| `memory.heap` | null | Always `null` for native services. |
| `memory.rss` | integer \| null | Resident set size in bytes. |
| `fds` | integer \| null | Open file descriptor count for the process. |
| `pid` | integer | Process ID of the running service. |
| `ip` | string | Caller IP address. Empty when the request arrives over a Unix socket. |
| `userAgent` | string | `User-Agent` header from the inbound request. |


The `ip` field is empty when the service is reached over a Unix domain socket rather than a TCP connection.


#### SDK usage



```bash
curl https://api.hoody.com/api/v1/files/health
```


```ts
const result = await client.files.health.check();

console.log(result.status);   // "ok"
console.log(result.service);  // "hoody-files"
console.log(result.pid);      // 17
```