> ## Documentation Index
> Fetch the complete documentation index at: https://kaneo.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update instance settings

> 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.



## OpenAPI

````yaml /openapi.json patch /admin/settings
openapi: 3.1.0
info:
  title: Kaneo API
  version: 1.0.0
  description: Kaneo Project Management API - Manage projects, tasks, labels, and more
servers:
  - url: https://cloud.kaneo.app/api
    description: Kaneo API Server
security:
  - bearerAuth: []
paths:
  /admin/settings:
    patch:
      tags:
        - Admin
      summary: Update instance settings
      description: >-
        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.
      operationId: updateInstanceSettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                instanceName:
                  type:
                    - string
                    - 'null'
                  maxLength: 60
                  description: >-
                    Shown in page titles and email headers and subjects. Empty
                    or null restores Kaneo.
                registrationEnabled:
                  type: boolean
                  description: >-
                    When false, only people with a valid invitation can create
                    an account. Locked when `DISABLE_REGISTRATION=true`.
                passwordRegistrationEnabled:
                  type: boolean
                  description: >-
                    When false, new accounts must use a social or OIDC provider.
                    Locked when `DISABLE_PASSWORD_REGISTRATION=true`.
                requireEmailVerification:
                  type: boolean
                  description: >-
                    New password sign-ups must confirm their email before they
                    can sign in. Requires email delivery.
                defaultRole:
                  type: string
                  minLength: 1
                  maxLength: 64
                  description: >-
                    Instance role for new users: `user` or a custom role name,
                    never `admin`. You can only choose a role whose permissions
                    you have.
                workspaceCreationRestricted:
                  type: boolean
                  description: >-
                    Only administrators can create workspaces. Locked when
                    `DISABLE_WORKSPACE_CREATION=true`.
                disabledIntegrations:
                  type: array
                  items:
                    type: string
                  maxItems: 32
                  description: >-
                    Integration provider types to turn off. Their connections
                    stop syncing and delivering, and projects can't connect
                    them.
      responses:
        '200':
          description: The saved settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceSettings'
        '400':
          description: >-
            Invalid value, `admin` as the default role, an unknown role or
            integration, or email verification without SMTP
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: >-
            The caller lacks the instance permission, used an API key, or chose
            a default role with permissions they lack
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: >-
            An environment variable locks the setting (code
            SETTING_LOCKED_BY_ENV)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/ApiKeyRateLimited'
components:
  schemas:
    InstanceSettings:
      type: object
      properties:
        instanceName:
          type:
            - string
            - 'null'
          description: The saved name, or null for the default Kaneo.
        instanceUrl:
          type:
            - string
            - 'null'
          description: The web app URL from `KANEO_CLIENT_URL`. Read-only.
        registrationEnabled:
          type: boolean
        passwordRegistrationEnabled:
          type: boolean
        requireEmailVerification:
          type: boolean
        defaultRole:
          type: string
        workspaceCreationRestricted:
          type: boolean
        disabledIntegrations:
          type: array
          items:
            type: string
        lockedByEnv:
          type: array
          items:
            type: string
            enum:
              - registrationEnabled
              - passwordRegistrationEnabled
              - workspaceCreationRestricted
          description: >-
            Settings an environment variable forces. Their values here are the
            effective ones.
        emailDeliveryConfigured:
          type: boolean
        roles:
          type: array
          items:
            type: string
          description: Custom instance roles that can be the default role.
        integrationProviders:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              name:
                type: string
            required:
              - type
              - name
      required:
        - instanceName
        - instanceUrl
        - registrationEnabled
        - passwordRegistrationEnabled
        - requireEmailVerification
        - defaultRole
        - workspaceCreationRestricted
        - disabledIntegrations
        - lockedByEnv
        - emailDeliveryConfigured
        - roles
        - integrationProviders
    ApiError:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of the error.
          example: Task not found
        code:
          type: string
          description: >-
            Stable UPPER_SNAKE_CASE code. Derived from the status unless a more
            specific code applies, such as VALIDATION_ERROR or
            MISSING_PERMISSION.
          example: NOT_FOUND
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
                description: >-
                  Dotted path to the invalid input, prefixed with the request
                  part (body, query, params, header).
                example: body.title
              message:
                type: string
                example: Required
            required:
              - path
              - message
          description: Every validation issue, for VALIDATION_ERROR.
        missingPermissions:
          type: array
          items:
            type: string
          description: >-
            Permissions the caller lacks for this route, as resource:action, for
            MISSING_PERMISSION and API_KEY_SCOPE.
          example:
            - task:update
      required:
        - message
        - code
  responses:
    ApiKeyRateLimited:
      description: >-
        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.
      headers:
        Retry-After:
          description: >-
            Seconds to wait before retrying. Omitted when an exhausted usage
            quota never refills.
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Requests the API key may make per window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left in the current window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix time in seconds when the current window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or session token (Bearer)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.