Check setup status | Envoy Documentation

GET /api/auth/status

Check setup status

Operation ID: getAuthStatus

Authentication

No authentication is required.

Success responses

200

Setup status

Content type: application/json

Type: object
Properties:
- needsSetup (boolean)
- totp_required (boolean) — Whether TOTP (2FA) is mandatory on this deployment (auth.totp_required, default true)

Examples

cURL

curl --request GET \
  --url 'https://your-envoy.example.com/api/auth/status'

JavaScript (fetch)

const response = await fetch('https://your-envoy.example.com/api/auth/status', {
  method: 'GET',
});
 
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);