Overseer Docs
API Reference

Authentication

Authentication API endpoints

Authentication

Login

usernamestringBodyRequired

Admin username

passwordstringBodyRequired

Admin password

POST /api/auth/login

Request:

{
  "username": "admin",
  "password": "your-password"
}

Response (200):

{
  "success": true,
  "user": {
    "id": 1,
    "username": "admin",
    "role": "admin"
  }
}

Logout

POST /api/auth/logout

Response (200):

{
  "success": true
}

Session Check

GET /api/auth/session

Response (200):

{
  "authenticated": true,
  "user": {
    "id": 1,
    "username": "admin",
    "role": "admin"
  }
}

On this page