PUT socket-server/{serverId}

Create or update a socket server.

Example

PUT /api/v1/socket-server/20 HTTP/1.1
Authorization: Signature ...
Content-Type: application/json

{
  "maxPlayers": 3000,
  "currentPlayers": 128,
  "status": "healthy"
}
----------------------------------------
HTTP/1.1 204 No Content
ETag: W/"a-bAsFyilMr4Ra1hIU5PyoyFRunpI"

Security

Authentication is required and restricted to system processes. Requests should be signed using a System key.

URL Parameters

NameDescriptionValue
serverIdthe ID of the server, 0 to 255number

Request Body

NameDescriptionValue
maxPlayersthe maximum allowed players for this servernumber
currentPlayersthe current players connected to this servernumber
statusthe current status of the server
one of:
  • pending
  • healthy
  • unhealthy
  • terminated

Response

Successful responses are code 204. Error responses are standard.

Response Body

NONE