USusekaneo
Admin

Get instance settings

Changed on

Read the instance-wide settings, which ones an environment variable locks, and the choices for the default role and integrations. Requires the instance:settings instance permission; API keys are rejected.

get/admin/settings

Request

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

Response

Instance 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