API

API reference: settings

Read and change the server address, version, join command, and reconnect settings from code.

4 min read

Read settings

GET /settings returns the global settings the API can manage. They are the same values as Settings → Connection, Behavior, Auto Reconnect, and Delays and timeouts in the dashboard.

{
  "settings": {
    "serverHost": "play.example.net",
    "serverPort": 25565,
    "bedrockServerHost": "",
    "bedrockServerPort": 19132,
    "version": "1.21.4",
    "bedrockVersion": "1.21.100",
    "joinCommand": "/server survival",
    "joinCommandEnabled": true,
    "joinCommandDelayMs": 3000,
    "antiAfk": true,
    "antiAfkIntervalSec": 30,
    "autoEat": false,
    "autoConfirmGuis": true,
    "chatLogging": true,
    "proxyRegionMatching": true,
    "fastReconnect": false,
    "fastReconnectDelayMs": 30000,
    "reconnectDelayMs": 300000,
    "proxyRetryDelayMs": 60000,
    "loginTimeoutMs": 60000,
    "spawnTimeoutMs": 180000
  }
}

Change settings

PATCH /settings changes only the fields you send. Everything else keeps its value.

curl -X PATCH https://dashboard.consoleclient.com/api/v1/settings \
  -H "Authorization: Bearer $CC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"serverHost": "mc.example.org", "serverPort": 25565, "version": "1.21.4"}'

{ "ok": true }

Settings apply the next time an account connects, the same as in the dashboard. To move accounts to a new server, change the settings, then disconnect and connect them.

Field	Type	Allowed values
`serverHost`	string	Java server address, up to 255 characters, no spaces or slashes.
`serverPort`	integer	1 to 65535.
`bedrockServerHost`	string	Bedrock server address. An empty string clears it.
`bedrockServerPort`	integer	1 to 65535.
`version`, `bedrockVersion`	string	A version from the dashboard’s version lists, such as `1.21.4`.
`joinCommand`	string	Up to 256 characters. See join commands.
`joinCommandEnabled`	boolean
`joinCommandDelayMs`	integer	0 to 600000.
`antiAfk`, `autoEat`, `autoConfirmGuis`, `chatLogging`, `proxyRegionMatching`, `fastReconnect`	boolean	See stay online and auto reconnect.
`antiAfkIntervalSec`	integer	10 to 600.
`fastReconnectDelayMs`	integer	10000 to 300000.
`reconnectDelayMs`	integer	300000 to 86400000.
`proxyRetryDelayMs`	integer	60000 to 86400000.
`loginTimeoutMs`	integer	60000 to 600000.
`spawnTimeoutMs`	integer	180000 to 1800000.

Error	HTTP	Meaning
`invalid_field`	400	A value has the wrong type or is out of range. The response names it in `field`. Nothing is saved when any field is invalid.
`no_valid_fields`	400	The body contained none of the fields above.

Fields that are not in the table are ignored. Every other dashboard setting, including Discord alerts, Spawner Sentry, Auto Sell, and combat, is managed in the dashboard only.

Need a hand?

Check the troubleshooting guide or return to all guides.

Read settings #

Change settings #

Read settings

Change settings