nextcloud / nextcloud/documentation

Generic and Publicly available Healthcheck API endpoint

Open
#15,617 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

0. needs triage
Dominant language
JavaScript
Stars
628
Forks
2.5k
Avg merge
2d 11h
Merged PRs (30d)
135

Description

Before You Submit
  • I have checked for existing issues and pull requests related to my suggestion.
  • I have posted on the Nextcloud Community Help Forum if my suggestion is a troubleshooting scenario or I'm unsure about the solution.
Type of Suggestion

Suggesting an improvement

Relevant Documentation Links

https://docs.nextcloud.com/server/stable/developer_manual/client_apis/general.html

Summary

Generic and Publicly Available Healthcheck API Endpoint With or Without Basic Auth via Headers

Details

Grabbing server startup health for Nextcloud Server seems way too complicated just for an external uptime server to display a server status.
The documentation never talks about an endpoint that can be GET'ed at to view a JSON formatted text to process if a server is online or not.

This should be easily accessible with or without a header basic authentication / bearer token.

Additional Notes

So far, all REST API endpoints stated on the documentation result to a CSRF token error, with no possible way to input a header basic authentication / bearer token. At least not stated in the Parameters section.

Looking at developer tools' network tab shows a heartbeat?format=json but uses a PUT method which tells me this is not what I need. The URL also shows apps/user_status which just solidifies my theory this is for letting the server know that a user is actively viewing the frontend so it shouldn't timeout the user.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked developer manual page at developer_manual/client_apis/general.html and review how the existing REST endpoints describe authentication and responses. Clarify whether the request is for a new public healthcheck endpoint or documentation of an existing one; done should include an explicit endpoint, response format, and authentication behavior.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.