Skip to content

Partial update group

PATCH
/api/v1/groups/{name}

Merges the supplied fields into the existing group configuration. Only fields present in the request body are updated; omitted fields are left unchanged.

name
required
string

Group name

object
runtimeTarget
object
platform
string
platformVersion
string
family
string
Allowed values: SERVER PROXY UNKNOWN
name
string
parent
string
platform
string
platformVersion
string
jarFile
string
templates
Array<string>
scalingMode
string
minInstances
required
integer format: int32
maxInstances
required
integer format: int32
maxPlayers
required
integer format: int32
scaleUpThreshold
required
number format: double
scaleDownAfterSeconds
required
integer format: int32
scaleCooldownSeconds
required
integer format: int32
predictiveScaling
required
boolean
scaleUpMargin
required
number format: double
burstCeiling
required
integer format: int32
routing
string
portRangeStart
required
integer format: int32
portRangeEnd
required
integer format: int32
startupTimeoutSeconds
required
integer format: int32
shutdownGraceSeconds
required
integer format: int32
drainOnShutdown
required
boolean
maxLifetimeSeconds
required
integer format: int32
isStatic
required
boolean
staticInstanceNames
Array<string>
protectedPaths
Array<string>
fallbackGroup
string
defaultGroup
required
boolean
dependsOn
Array<string>
startupWeight
required
integer format: int32
maintenance
required
boolean
maintenanceMessage
string
maintenanceBypass
Array<string>
updateStrategy
string
nodeAffinity
Array<string>
nodeAntiAffinity
Array<string>
spreadConstraint
string
priority
required
integer format: int32
memoryMb
required
integer format: int32
cpuReservation
required
number format: double
diskReservationMb
required
integer format: int64
jvmArgs
Array<string>
env
object
key
additional properties
string
motds
Array<string>
motdMode
string
motdIntervalSeconds
required
integer format: int32
attachedModules
Array<string>
enabledModules
Array<string>
disabledModules
Array<string>
attachedExtensions
Array<string>
enabledExtensions
Array<string>
disabledExtensions
Array<string>
configPatches
object
key
additional properties
object
key
additional properties
string

OK

Invalid configuration

Unauthorized

Forbidden

Group not found