SIsipcapture
Auth

Create session (login)

Changed on
post/auth/sessions

Request

  • Base URL
    /api/v4 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v4/auth/sessions
  • Auth
    none required

Request body

usernamestring required
passwordstring required

User password (not the default bootstrap password unless configured explicitly)

type'internal' | 'ldap'

Password backend — internal (DuckDB users / admin hash) or ldap when LDAP is enabled.

rememberboolean

When true, the UI may persist data.token in localStorage (Remember me). HttpOnly cookie is always set when cookie_enable is true.

Example request

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

Response

Session created

Example response

{
  "data": {
    "scope": "b9f6q23a-0bde-41ce-cd36-da3dbc17ea12"
  }
}

Changes