Maintenance Mode

Once or twice per year, Clerk undergoes maintenance on its infrastructure and enters Maintenance Mode. During this time, users who are already signed in will not be signed out, and will continue to have access to your app. However, new sign-ups, sign-ins and user mutations will return an error. Maintenance Mode is a special operational state designed to minimize disruption for signed-in users during critical database upgrades or outages.

Production instances

Mutation methods (POST, PATCH, PUT, DELETE) will be rejected with a SystemUnderMaintenance error. This includes all new sign-ups and sign-ins.

Active sessions, and session refresh requests are not affected. This applies to GET requests as well as session refresh requests (/touch and /tokens endpoints). Users who are 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 SystemUnderMaintenance error.

API errors

All mutations from both the Frontend API and the Backend API will return the following SystemUnderMaintenance error.

// 503 StatusServiceUnavailable
{
  "shortMessage": "System under maintenance",
  "longMessage": "We are currently undergoing maintenance and only essential operations are permitted. We will be back shortly.",
  "code": "maintenance_mode"
}

UI components

During Maintenance Mode, Clerk's UI components will display the following error for sign-ins, sign-ups, and all mutations to user and org data.

Development instances

For development instances, all requests will return a SystemUnderMaintenance error, and the instance will be completely unavailable.