USusekaneo
Admin

Update instance settings

Changed on

Change one or more instance-wide settings. Other API instances apply a change within a few seconds. Requires the instance:settings instance permission; API keys are rejected.

patch/admin/settings

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/admin/settings
  • Auth
    HTTP bearer

Request body

instanceNamestring nullable

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

registrationEnabledboolean

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

passwordRegistrationEnabledboolean

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

requireEmailVerificationboolean

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

defaultRolestring

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

workspaceCreationRestrictedboolean

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

disabledIntegrationsstring[]

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

Response

The saved settings

instanceNamestring nullable required

The saved name, or null for the default Kaneo.

instanceUrlstring nullable required

The web app URL from KANEO_CLIENT_URL. Read-only.

registrationEnabledboolean required
passwordRegistrationEnabledboolean required
requireEmailVerificationboolean required
defaultRolestring required
workspaceCreationRestrictedboolean required
disabledIntegrationsstring[] required
lockedByEnvstring[] required

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

emailDeliveryConfiguredboolean required
rolesstring[] required

Custom instance roles that can be the default role.

Changes