Skip to content

Get Basic System Settings

GET
/system/basic-settings
curl --request GET \
--url https://sylve.lan:8181/api/system/basic-settings \
--header 'Authorization: <Authorization>'

Get basic system settings information

Success

Media typeapplication/json
object
data
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
error
string
message
string
status
string
Example
{
"data": {
"services": [
"dhcp-server"
]
}
}

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}