Skip to main content
PUT
/
v0
/
persistent-servers
Update a persistent server
curl --request PUT \
  --url https://controller.platform.simplecloud.app/v0/persistent-servers \
  --header 'Content-Type: application/json' \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>' \
  --data '{}'
{
  "active": true,
  "created_at": "2023-01-01T12:00:00Z",
  "max_memory": 2048,
  "max_players": 50,
  "min_memory": 1024,
  "name": "my-persistent-server",
  "persistent_server_id": "123e4567-e89b-12d3-a456-426614174000",
  "properties": {},
  "serverhost_id": "123e4567-e89b-12d3-a456-426614174000",
  "source": {
    "blueprint": "123e4567-e89b-12d3-a456-426614174000",
    "image": "ghcr.io/user/custom-image:latest",
    "type": "blueprint"
  },
  "tags": [
    "<string>"
  ],
  "type": "SERVER",
  "updated_at": "2023-01-01T12:00:00Z",
  "workflows": {
    "manual": [
      "<string>"
    ],
    "when": {
      "start": [
        "<string>"
      ],
      "stop": [
        "<string>"
      ]
    }
  }
}

Headers

X-Network-ID
string
required

Network ID

X-Network-Secret
string
required

Network Secret

Query Parameters

persistent_server_id
string
required

Persistent Server ID

Body

application/json

Persistent server details

The body is of type object.

Response

OK

Response for updating a persistent server

active
boolean
Example:

true

created_at
string
Example:

"2023-01-01T12:00:00Z"

max_memory
integer
Example:

2048

max_players
integer
Example:

50

min_memory
integer
Example:

1024

name
string
Example:

"my-persistent-server"

persistent_server_id
string
Example:

"123e4567-e89b-12d3-a456-426614174000"

properties
object
serverhost_id
string
Example:

"123e4567-e89b-12d3-a456-426614174000"

source
object

Source configuration for server groups

tags
string[]
type
string
Example:

"SERVER"

updated_at
string
Example:

"2023-01-01T12:00:00Z"

workflows
object

Workflows configuration for server groups