Skip to main content
PATCH
Update instance settings

Authorizations

Authorization
string
header
required

API key or session token (Bearer)

Body

application/json
instanceName
string | null

Shown in page titles and email headers and subjects. Empty or null restores Kaneo.

Maximum string length: 60
registrationEnabled
boolean

When false, only people with a valid invitation can create an account. Locked when DISABLE_REGISTRATION=true.

passwordRegistrationEnabled
boolean

When false, new accounts must use a social or OIDC provider. Locked when DISABLE_PASSWORD_REGISTRATION=true.

requireEmailVerification
boolean

New password sign-ups must confirm their email before they can sign in. Requires email delivery.

defaultRole
string

Instance role for new users: user or a custom role name, never admin. You can only choose a role whose permissions you have.

Required string length: 1 - 64
workspaceCreationRestricted
boolean

Only administrators can create workspaces. Locked when DISABLE_WORKSPACE_CREATION=true.

disabledIntegrations
string[]

Integration provider types to turn off. Their connections stop syncing and delivering, and projects can't connect them.

Maximum array length: 32

Response

The saved 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