Skip to content

docs: Fix server API key doc for /props (move it to /health) #14352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 24, 2025
Merged

docs: Fix server API key doc for /props (move it to /health) #14352

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion tools/server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,8 @@ node index.js

### GET `/health`: Returns heath check result

This endpoint is public (no API key check).

**Response format**

- HTTP status code 503
Expand Down Expand Up @@ -708,7 +710,7 @@ If the tokens are missing, then the extra context is simply prefixed at the star

### **GET** `/props`: Get server global properties.

This endpoint is public (no API key check). By default, it is read-only. To make POST request to change global properties, you need to start server with `--props`
By default, it is read-only. To make POST request to change global properties, you need to start server with `--props`

**Response format**

Expand Down