docs: document nat serve /health endpoint in REST API guide

[valter-silva-au]

Description

Documents the FastAPI GET /health endpoint exposed by nat serve in the REST API server endpoints guide. The endpoint is registered automatically by nat serve (it is not gated by any config flag), but was previously undocumented for the FastAPI path, even though the MCP and FastMCP guides already document their own health checks.

This adds a Health Check Endpoint section to docs/source/reference/rest-api/api-server-endpoints.md covering:

• Route GET /health, intended for liveness/readiness probes — it returns immediately without executing a workflow and requires no model or API credentials, so it is safe behind reverse proxies, process supervisors, and Docker/Kubernetes health checks.
• A curl example and the {"status":"healthy"} 200 response.
• A note distinguishing the FastAPI health check (default port 8000) from the MCP (9901) and FastMCP (9902) health routes, with cross-links to both existing guides.

Docs-only change; no behavior change.

Note: I noticed the issue is assigned to @bbednarski9 — happy to defer or hand this off if it's already in progress. Opening this since the maintainer invited a small docs PR and there wasn't a linked PR yet.

Closes #2073

By Submitting this PR I confirm:

• I am familiar with the Contributing Guidelines.
• We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  • Any contribution which contains commits that are not Signed-Off will not be accepted.
• When the PR is ready for review, new or existing tests cover these changes.
• When the PR is ready for review, the documentation is up to date with these changes.

Summary by CodeRabbit

• Documentation
  • Added reference docs for a new /health GET endpoint.
  • Clarified that the endpoint is available automatically when starting nat serve and can be used as a quick liveness/readiness check.
  • Included example requests and responses, plus notes on separate /health routes for MCP/FastMCP servers on their own ports.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 0d65c3d0-7214-4552-8291-c1d9b83e5084

📥 Commits

Reviewing files that changed from the base of the PR and between d2f1c9c and a9e7acb.

📒 Files selected for processing (1)

• docs/source/reference/rest-api/api-server-endpoints.md

---

Walkthrough

The REST API server endpoints guide now documents a GET /health route for nat serve, including its response, curl example, and a note about separate MCP and FastMCP health routes.

Changes

REST API health documentation

Layer / File(s)	Summary
Health endpoint section docs/source/reference/rest-api/api-server-endpoints.md	Adds a GET /health section for nat serve with its purpose, example request/response, and a note about MCP and FastMCP health routes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title is concise, descriptive, and uses an imperative verb to summarize the docs-only health endpoint update.
Linked Issues check	✅ Passed	The docs add nat serve /health coverage with 200/healthy semantics, probe usage, no credentials, and MCP/FastMCP differentiation.
Out of Scope Changes check	✅ Passed	The change is limited to documenting the missing REST API health endpoint and related routing notes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands.}

[willkill07]

/ok to test a9e7acb

[willkill07]

avoid slashes since they can easily be mistaken for paths

[willkill07]

Suggested change

	health checks, and Kubernetes-style readiness/liveness probes.
	health checks, and Kubernetes-style readiness and liveness probes.

[willkill07]

Suggested change

	- **Description:** A liveness/readiness probe for the running server. It is registered automatically
	- **Description:** A liveness and readiness probe for the running server. It is registered automatically

[willkill07]

@valter-silva-au do you still plan to address this?

[valter-silva-au]

Yes, still on it — apologies for the silence, @willkill07.

Both of your suggestions are applied (liveness and readiness / readiness and liveness instead of the slashes), and I've rebased onto current develop. That same change is also what fixes the red CI Pipeline / Check: the failure was path_checks.py reading liveness/readiness in prose as a file path —

docs/source/reference/rest-api/api-server-endpoints.md:91:22 -> liveness/readiness
docs/source/reference/rest-api/api-server-endpoints.md:94:39 -> readiness/liveness

so your review comment and the CI failure were the same root cause. python3 ci/scripts/path_checks.py now passes locally.

I've hit a push restriction on the machine I have this branch on, so the revision isn't up yet. I'm sorting that out and will push and re-request review — shouldn't be long. Thanks for the nudge.