Skip to content

Commit

Permalink
Maintenance mode doc (#1686)
Browse files Browse the repository at this point in the history
Co-authored-by: Jeff Escalante <[email protected]>
Co-authored-by: victoria <[email protected]>
  • Loading branch information
3 people authored Nov 12, 2024
1 parent df17d02 commit f113310
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/maintenance-mode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Maintenance Mode
description: Learn about Clerk's Maintenance Mode.
---

**Maintenance Mode** is a special operational state designed to ensure minimal disruption to signed-in users during critical database upgrades or outages.

## Production instances

Mutation methods (`POST`, `PATCH`, `PUT`, `DELETE`) will be rejected with a `503 Service Unavailable` status, along with an error message informing users that the system is temporarily unavailable. This includes all sign-up and sign-in attempts. Clerk's prebuilt components and the hosted Account Portal will display errors for these requests.

GET requests, as well as session refresh requests ([`/touch`](/docs/reference/frontend-api/tag/Sessions#operation/touchSession) and [`/tokens`](/docs/reference/frontend-api/tag/Sessions#operation/createSessionToken) endpoints), aren't affected. Users with active sessions (already signed in) will not be signed out, and will continue to have access to your app. However, any mutations to their user or org data will return the same `503` error.

## Development instances

During this period, development instances will experience full downtime. Users will be unable to sign up or in, and already signed-in users will be signed out.

0 comments on commit f113310

Please sign in to comment.