restart Action
Restarts a server using the configured control API.
Control API required
All server management actions require:
- Server configuration in the
servers:section ofconfig.yml - A configured control API
See Servers for configuration details.
Shell Control API
When using the Shell Control API, the restart_command is required in the server's control API configuration.
MOTD caching
Before restarting a server, AutoStartStop automatically caches the server's MOTD (Message of the Day). This cached MOTD can be displayed when the server is offline using the respond_ping action with use_cached_motd: true.
Configuration
action:
- restart:
server: survival # Required: Server name
Configuration fields
| Field | Default | Description |
|---|---|---|
server | - | The server name to restart |
How it works
When the restart action is executed, AutoStartStop caches the server's MOTD (while the server is still online) and sends the restart command to the server using the configured Control API.
Example
rules:
nightly_restart:
triggers:
- cron:
expression: '0 3 * * *' # Every day at 3 AM
action:
- send_message:
server: survival
message: "<yellow>Server will restart in 1 minute.</yellow>" # Notify players
- sleep:
duration: 1m # Wait 1 minute
- restart:
server: survival # Restart the server