API Reference

Check setup status

View Markdown

GET /api/auth/status

Check setup status

Operation IDgetAuthStatus

Authentication

No authentication is required.

Success response body

200Setup status

Setup status

Content typeapplication/json

responseobject

2 properties

needsSetupboolean

totp_requiredboolean

Whether TOTP (2FA) is mandatory on this deployment (auth.totp_required, default true)

Code examples

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

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);