Skip to content

Document maintenance mode header #9189

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
Sep 30, 2022
Merged

Document maintenance mode header #9189

Show file tree
Hide file tree
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
15 changes: 15 additions & 0 deletions developer_manual/client_apis/general.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
=======
General
=======

Nextcloud's APIs are mainly available through :ref:`rest-apis`, :ref:`OCS <ocsapiindex>` and :ref:`webdavapiindex`.

Generic Errors
--------------

Additional to specific errors of an API, there are a few generic errors Nextcloud might throw on web APIs.

Maintenance Mode
****************

If Nextcloud is down for maintenance, it sends a HTTP response with status code 503 and the header ``x-nextcloud-maintenance-mode: 1``.
1 change: 1 addition & 0 deletions developer_manual/client_apis/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Clients and Client APIs
.. toctree::
:maxdepth: 2

general
android_library/index
WebDAV/index
OCS/index
Expand Down
2 changes: 2 additions & 0 deletions developer_manual/digging_deeper/rest_apis.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _rest-apis:

=========
REST APIs
=========
Expand Down