# Установка

API методы для установки.

## `GET /api/setup/admin_checklist`

Возвращает различные шаги "контрольного списка администратора" вместе с информацией о том, были ли они выполнены. 

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

## `GET /api/setup/user_defaults`

Возвращает объект, содержащий сведения о пользователе по умолчанию для первоначальной настройки, если он настроен и если предоставленное значение токена соответствует токену в значении конфигурации.

### Параметры:

* **`token`**

## `POST /api/setup/`

Специальный метод для создания первого пользователя во время установки. Этот метод создает пользователя, осуществляет его вход в систему и возвращает ID сессии. Данный метод может быть использован для добавления базы данных, создания и инициации второго администратора, и/или устанавливания специальных настроек, задаваемых в процессе установки.

### Параметры:

* **`engine`** 

* **`schedules`** *:metabase.sync.schedules/ExpandedSchedulesMap* или null.

* **`allow_tracking`** логическое значение, допустимая логическая строка (`true` или `false`) или null.

* **`invited_last_name`** непустая строка или null.

* **`site_locale`** null или строка, являющаяся допустимым двухбуквенным ISO-кодом языка или кодом сочетания "язык_страна", например, *en* или *en_US*.

* **`email`** допустимый адрес электронной почты.

* **`first_name`** непустая строка или null.

* **`request`** 

* **`auto_run_queries`** логическое значение или null.

* **`password`** пароль.

* **`name`** 

* **`invited_email`** допустимый адрес электронной почты или null.

* **`invited_first_name`** непустая строка или null.

* **`site_name`** непустая строка.

* **`token`** токен, не совпадающий с токеном установки.

* **`details`** 

* **`database`** 

* **`last_name`** непустая строка или null.

## `POST /api/setup/validate`

Подтвердить, что мы можем подключиться к базе данных, используя указанный набор деталей.

### Параметры:

* **`engine`** допустимый механизм базы данных.

* **`details`** 

* **`token`** токен, не совпадающий с токеном установки.

---

[<< Назад к разделу API](./api-documentation.md)