Skip to content
Engauge Docs

Update Server

PATCH
/api/v1/servers/{id}

Update a server. Uses JSON patch. Note that some fields are not patchable.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: int64

The ID of the server.

Request Body

Section titled “Request Body ”

A JSON patch document to apply to the server.

object
operations
Array<object>
nullable
object
operationType
integer format: int32
Allowed values: 0 1 2 3 4 5 6
path
string
nullable
op
string
nullable
from
string
nullable
value
nullable
contractResolver
object

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

object
id
string format: int64
name
string
nullable
icon
string
nullable
commandsWhitelist
boolean
xpWhitelist
boolean
commandsChannels
Array<string>
nullable
xpChannels
Array<string>
nullable
messageXp
integer format: int32
levelFormula
string
nullable
levelMessageEnabled
boolean
nullable
levelMessage
string
nullable
levelMessageLocation
string format: int64
nullable
voiceXp
integer format: int32
deleteOnLeave
boolean
nullable
economy
boolean
currencySymbol
string
nullable
levelCurrency
integer format: int32
startingCurrency
integer format: int32
currencyTransfer
boolean
nullable
public
boolean
nullable
crateError
boolean
nullable
shop
boolean
shopLogChannel
string format: int64
nullable
aboutText
string
nullable
currencyTransferMin
integer format: int32
currencyTransferPing
boolean
nullable
economyGames
boolean
nullable
crates
Array<object>
nullable
object
id
integer format: int32
serverId
string format: int64
name
string
nullable
criteria
integer format: int32
criteriaCount
integer format: int32
channels
Array<string>
nullable
xp
integer format: int32
duration
integer format: int32
criteriaProgress
integer format: int32
dropTime
string format: date-time
announcementChannel
string format: int64
nullable
announcementMessage
string
nullable
color
integer format: int32
maxRedeemers
integer format: int32
pingHere
boolean
redeemers
Array<string>
nullable
cooldown
integer format: int32
imageUrl
string
nullable
reaction
boolean
currency
integer format: int32
dropMessage
string format: int64
nullable
dropNow
boolean
showRedeems
boolean
pingRoles
Array<string>
nullable
server
object recursive
roles
Array<object>
nullable
object
id
string format: int64
serverId
string format: int64
level
integer format: int32
xpMultiplier
number format: float
levelMessage
string
nullable
stack
boolean
stackGroup
string
nullable
dependencies
Array<string>
nullable
shops
Array<object>
nullable
object
serverId
string format: int64
id
string format: uuid
name
string
nullable
price
integer format: int32
description
string
nullable
reward
string
nullable