Skip to content
Reviactyl v26 has been released!
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Settings

Renames a server

post
Path parameters
serverintegerRequired

The server ID

Body
namestring · min: 1 · max: 191Required
descriptionstring · nullableOptional
Responses
204

No content

application/json
string[]Optional
post/servers/{server}/settings/rename
POST /api/client/servers/{server}/settings/rename HTTP/1.1
Host: reviactyl.test
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "name": "text",
  "description": null
}
[
  "text"
]

Reinstalls the server on the daemon

post
Path parameters
serverintegerRequired

The server ID

Responses
202Success
application/json
string[]Optional
post/servers/{server}/settings/reinstall
POST /api/client/servers/{server}/settings/reinstall HTTP/1.1
Host: reviactyl.test
Accept: */*
[
  "text"
]

Changes the Docker image in use by the server

put
Path parameters
serverintegerRequired

The server ID

Body
docker_imagestring · max: 191RequiredPattern: ^[\w#\.\/\- ]*\|?~?[\w\.\/\-:@ ]*$
Responses
204

No content

application/json
string[]Optional
put/servers/{server}/settings/docker-image
PUT /api/client/servers/{server}/settings/docker-image HTTP/1.1
Host: reviactyl.test
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "docker_image": "text"
}
[
  "text"
]
put
Path parameters
serverintegerRequired

The server ID

Body
timezonestring · max: 64 · nullableRequired
Responses
204

No content

application/json
string[]Optional
put/servers/{server}/settings/timezone
PUT /api/client/servers/{server}/settings/timezone HTTP/1.1
Host: reviactyl.test
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "timezone": null
}
[
  "text"
]

Updates the category for the server

put
Path parameters
serverintegerRequired

The server ID

Body
categorystring · nullableOptional
Responses
204

No content

application/json
string[]Optional
put/servers/{server}/settings/category
PUT /api/client/servers/{server}/settings/category HTTP/1.1
Host: reviactyl.test
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "category": null
}
[
  "text"
]

Last updated

Was this helpful?