Skip to content
SYLVE

Set Service State

PATCH
/system/basic-settings/services/{service}
curl --request PATCH \
  --url https://sylve.lan:8181/api/system/basic-settings/services/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true }'

Set the desired enabled state of a service in the system settings

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
service
required
string

Service name

Request Body

Section titled “Request Body”

Desired service state

Media typeapplication/json
object
enabled
required
boolean
Examplegenerated
{
  "enabled": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
object
changed
boolean
enabled
boolean
service
string
Allowed values: dhcp-server jails samba-server virtualization wol-server firewall wireguard iscsi mdns
error
string
message
string
status
string
Example
{
  "data": {
    "service": "dhcp-server"
  }
}

400

Section titled “400”

Bad Request

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

401

Section titled “401”

Unauthorized

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

403

Section titled “403”

Forbidden

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

404

Section titled “404”

Not Found

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

413

Section titled “413”

Request Entity Too Large

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

500

Section titled “500”

Internal Server Error

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