Login

POST

/auth/login

curl --request POST \
  --url https://sylve.lan:8181/api/auth/login \
  --header 'Content-Type: application/json' \
  --data '{ "authType": "sylve", "password": "example", "remember": true, "username": "example" }'

Authenticate an administrator and create a local session

Request Body

Login request body

Media typeapplication/json

object

authType

required

string

Allowed values: sylve pam

password

required

string

>= 3 characters <= 128 characters

remember

boolean

username

required

string

>= 3 characters <= 128 characters

Responses

200

Success

Media typeapplication/json

object

data

object

basicSettings

object

id

integer

initialized

boolean

pools

Array<string>

restarted

boolean

services

Array<string>

Allowed values: dhcp-server jails samba-server virtualization wol-server firewall wireguard iscsi mdns

hostname

string

nodeId

string

token

string

error

string

message

string

status

string

Example

{
  "data": {
    "basicSettings": {
      "services": [
        "dhcp-server"
      ]
    }
  }
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Request Entity Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

429

Too Many Requests

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Service Unavailable

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}