Skip to main content
GET
Get instance settings

Authorizations

Authorization
string
header
required

API key or session token (Bearer)

Response

Instance settings

instanceName
string | null
required

The saved name, or null for the default Kaneo.

instanceUrl
string | null
required

The web app URL from KANEO_CLIENT_URL. Read-only.

registrationEnabled
boolean
required
passwordRegistrationEnabled
boolean
required
requireEmailVerification
boolean
required
defaultRole
string
required
workspaceCreationRestricted
boolean
required
disabledIntegrations
string[]
required
lockedByEnv
enum<string>[]
required

Settings an environment variable forces. Their values here are the effective ones.

Available options:
registrationEnabled,
passwordRegistrationEnabled,
workspaceCreationRestricted
emailDeliveryConfigured
boolean
required
roles
string[]
required

Custom instance roles that can be the default role.

integrationProviders
object[]
required