feat: add --workspace-status-json to boardwalkd to generate JSON status for all workspaces#229
Merged
asullivan-blze merged 2 commits intomainfrom Mar 16, 2026
Merged
Conversation
Adds a static service token mechanism for machine-to-machine API access without browser-based login or token expiry. When --service-token (or BOARDWALKD_SERVICE_TOKEN env var) is set, requests bearing that value in the boardwalk-api-token header authenticate as service@boardwalk. Also adds GET /api/workspaces/status, a read-only endpoint that returns all workspace names, details, semaphores, and last-seen timestamps for monitoring integrations. Made-with: Cursor
Adds a boardwalkd flag `--workspace-status-json` to enable the route /api/workspaces/status to provide a JSON object containing the status for all known workspaces. This can, for example, feed into a secondary monitoring system, allowing the status of Boardwalk to be centrally monitored by a NOC team, for example. Co-authored-by: lorelei@backblaze.com
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why?
Adds a boardwalkd flag
--workspace-status-jsonto enable the route/api/workspaces/status to provide a JSON object containing the status
for all known workspaces.
This could, for example, feed into a secondary monitoring system, allowing
the status of Boardwalk to be centrally monitored by a NOC team, for
example.
How was this tested?
The full
make testsuite passes, and verified thathttp://localhost:8888/api/workspaces/statusproduced the desired result.Checklist
versionin the[project]section ofthe
pyproject.tomlfile (if applicable)?