---
title: "Login"
method: POST
path: "/auth/login"
tags: ["Authentication"]
---

# Login

`POST /auth/login`

Authenticate an administrator and create a local session

## Request body

- InternalHandlersAuthLoginRequest
  - `authType` 'sylve' | 'pam', required
  - `password` string, required
  - `remember` boolean
  - `username` string, required

## Response `200`

Success

- GithubComAlchemillahqSylveInternalAPIResponseInternalHandlersAuthSuccessfulLogin
  - `data` InternalHandlersAuthSuccessfulLogin
    - `basicSettings` GithubComAlchemillahqSylveInternalDbModelsBasicSettings
      - `id` integer
      - `initialized` boolean
      - `pools` string[]
      - `restarted` boolean
      - `services` GithubComAlchemillahqSylveInternalDbModelsAvailableService[]
    - `hostname` string
    - `nodeId` string
    - `token` string
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `413` — Request Entity Too Large
- `429` — Too Many Requests
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/alchemillahq/apis/sylve-api.md) · [All operations](https://skmtc.net/alchemillahq/apis/sylve-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/alchemillahq/sylve-api/revisions/7a7bea85004e/schema)