---
title: "check if the lakeFS installation is already set up"
method: GET
path: "/setup_lakefs"
tags: ["internal"]
---

# check if the lakeFS installation is already set up

`GET /setup_lakefs`

## Response `200`

lakeFS setup state

- SetupState
  - `state` 'initialized' | 'not_initialized'
  - `comm_prefs_missing` boolean — true if the comm prefs are missing.
  - `login_config` LoginConfig
    - `RBAC` 'none' | 'simplified' | 'internal' | 'external' — RBAC will remain enabled on GUI if "external". That only works with an external auth service.
    - `username_ui_placeholder` string — Placeholder text to display in the username field of the login form.
    - `password_ui_placeholder` string — Placeholder text to display in the password field of the login form.
    - `login_url` string, required — Primary URL to use for login.
    - `login_url_method` 'none' | 'redirect' | 'select' — Defines login behavior when login_url is set. - none: For OSS users. - redirect: Auto-redirect to login_url. - select: Show a page to choose between logging in via login_url or with lakeFS credentials. Ignored if login_url is not configured.
    - `login_failed_message` string — Message to display to users who fail to login; a full sentence that is rendered in HTML and may contain a link to a secondary login method
    - `fallback_login_url` string — Secondary URL to offer users to use for login.
    - `fallback_login_label` string — Label to place on fallback_login_url.
    - `login_cookie_names` string[], required — Cookie names used to store JWT
    - `logout_url` string, required — URL to use for logging out.

## Other responses

- `429` — too many requests
- `default` — Internal Server Error

## Changes

> 52 revisions in range; 1 could not be searched.

- **2025-08-21** `d457bf1cd984` — 1 warning, 1 info
  - added the new `internal` enum value to the `login_config/RBAC` response property for the response status `200`
  - added the optional property `login_config/login_url_method` to the response with the `200` status
- **2025-07-29** `27799ffec9a5` — 2 info
  - added the non-success response with the status `429`
  - removed the non-success response with the status `420`
- **2025-01-23** `5441b0cd17bf` — 2 info
  - added the optional property `login_config/password_ui_placeholder` to the response with the `200` status
  - added the optional property `login_config/username_ui_placeholder` to the response with the `200` status
- **2024-09-17** `3b10653a8013` — 3 warning, 3 info
  - removed the optional property `login_config/login_url_method` from the response with the `200` status
  - removed the optional property `login_config/password_ui_placeholder` from the response with the `200` status
  - removed the optional property `login_config/username_ui_placeholder` from the response with the `200` status
  - added the non-success response with the status `420`
  - …2 more

[Change history](https://skmtc.dev/treeverse/apis/lakefs-api/changes/setup_lakefs/get.md)

---

[API](https://skmtc.dev/treeverse/apis/lakefs-api.md) · [All operations](https://skmtc.dev/treeverse/apis/lakefs-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/treeverse/lakefs-api/revisions/4617f80bee61/schema)