---
title: "Get instance settings"
method: GET
path: "/admin/settings"
tags: ["Admin"]
---

# Get instance settings

`GET /admin/settings`

## Request

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

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.

## Response `200`

Instance settings

- InstanceSettings
  - `instanceName` string, nullable, required: The saved name, or null for the default Kaneo.
  - `instanceUrl` string, nullable, 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` string[], required: Settings an environment variable forces. Their values here are the effective ones.
  - `emailDeliveryConfigured` boolean, required
  - `roles` string[], required: Custom instance roles that can be the default role.
  - `integrationProviders` object[], required
    - `type` string, required
    - `name` string, required

## Other responses

- `401`: Missing or invalid credentials
- `403`: The caller lacks the instance permission or used an API key
- `429`: The API key exceeded its rate limit or usage quota. Wait the number of seconds in Retry-After before retrying. The X-RateLimit headers are sent only when the rate limit was hit.

## Changes

- **2026-10-27** `0f9a0a057a49`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usekaneo/apis/kaneo-api/changes/admin/settings/get.md)

---

[API](https://skmtc.dev/usekaneo/apis/kaneo-api.md) - [All operations](https://skmtc.dev/usekaneo/apis/kaneo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usekaneo/apis/kaneo-api/revisions/741a49dfb347?raw)