docs(rest-api): document the FastAPI /health endpoint

[Rekin226]

Summary

Adds a short Health Check Endpoint section to the REST API server endpoints guide (docs/source/reference/rest-api/api-server-endpoints.md) so that the GET /health route exposed by nat serve is discoverable in the public docs.

The endpoint was added in #1466 but was never documented in the REST API reference, leaving operators without a documented liveness/readiness URL to use behind reverse proxies, Docker HEALTHCHECK, or Kubernetes probes.

What the new section covers

• Route (/health), method (GET), and the {"status":"healthy"} response.
• Explicit note that the endpoint does not execute a workflow and does not require API credentials, so it is safe as a probe target.
• Cross-links to the existing MCP and FastMCP server guides, which already document their own separate /health routes and default ports.

Placement

Inserted immediately after HTTP Interactive Extensions and before Start the NeMo Agent Toolkit Server, so a reader scanning "Default Endpoint Paths" hits it early without disturbing the versioned endpoint table (the health route is not versioned).

Scope

Docs-only. No source, config, or endpoint-registration code changed.

Closes #2073

Summary by CodeRabbit

• Documentation
  • Added reference documentation for the GET /health endpoint.
  • Documented liveness and readiness checks, a sample request, and the expected healthy response.
  • Clarified that MCP/FastMCP provide separate health endpoints on different 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: 9c26fd06-7271-4309-8c4b-8623e23b666e

📥 Commits

Reviewing files that changed from the base of the PR and between e8692d0 and e494636.

📒 Files selected for processing (1)

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

---

Walkthrough

The REST API endpoint guide adds documentation for GET /health, including its liveness/readiness purpose, curl request, healthy JSON response, and distinction from MCP/FastMCP health routes.

Changes

REST API health documentation

Layer / File(s)	Summary
Health check endpoint documentation docs/source/reference/rest-api/api-server-endpoints.md	Documents GET /health, its liveness/readiness use, example request and response, and separate MCP/FastMCP health routes.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Linked Issues check	❓ Inconclusive	The docs add the /health endpoint, sample response, liveness/readiness purpose, and cross-links as requested, but the no-credentials/no-workflow detail is not explicit in the summary.	Confirm the new section explicitly states that /health does not execute workflows and does not require model or API credentials.

✅ Passed checks (4 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 accurately reflects the docs-only change.
Out of Scope Changes check	✅ Passed	The PR is docs-only and stays focused on the REST API health-check documentation without unrelated code changes.
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.}

[Rekin226]

Hi @mdemoret — just a gentle nudge on this one. This PR closes #2073 (the docs-only issue you greenlit for a small PR). It's been waiting on the copy-pr-bot vetter workflow before CI can run. Whenever you or another maintainer have a moment, could you kick off the vetter step? Happy to address any review feedback promptly. Thanks!

[willkill07]

This is a duplicate of #2094