curl --request PATCH \
--url https://controller.platform.simplecloud.app/v0/servers \
--header 'Content-Type: application/json' \
--header 'X-Network-ID: <x-network-id>' \
--header 'X-Network-Secret: <x-network-secret>' \
--data '{}'{
"server": {
"cpu_usage": 25.5,
"created_at": "2023-01-01T12:00:00Z",
"ip": "127.0.0.1",
"last_activity": "2023-01-01T12:00:00Z",
"max_memory": 2048,
"max_players": 20,
"memory_usage": 512,
"min_memory": 1024,
"network_id": "123e4567-e89b-12d3-a456-426614174000",
"numerical_id": 1,
"persistent_server": {
"active": true,
"created_at": "<string>",
"id": "<string>",
"max_memory": 123,
"max_players": 123,
"min_memory": 123,
"name": "<string>",
"properties": {},
"serverhost_id": "<string>",
"source": {
"blueprint": "123e4567-e89b-12d3-a456-426614174000",
"image": "ghcr.io/user/custom-image:latest",
"type": "blueprint"
},
"tags": [
"<string>"
],
"type": "<string>",
"updated_at": "<string>",
"workflows": {
"manual": [
"<string>"
],
"when": {
"start": [
"<string>"
],
"stop": [
"<string>"
]
}
}
},
"persistent_server_id": "123e4567-e89b-12d3-a456-426614174000",
"player_count": 5,
"port": 25565,
"properties": {},
"server_group": {
"created_at": "<string>",
"deployment_config": {},
"deployment_strategy": "<string>",
"id": "<string>",
"name": "<string>",
"properties": {},
"scaling_config": {},
"source": {
"blueprint": {
"configurator": "<string>",
"created_at": "<string>",
"id": "<string>",
"minecraft_version": "<string>",
"name": "<string>",
"runtime_config": {},
"server_software": "<string>",
"server_url": "<string>",
"software_version": "<string>",
"updated_at": "<string>",
"workflow_steps": [
"<string>"
]
},
"image": "<string>",
"type": "<string>"
},
"tags": [
"<string>"
],
"type": "<string>",
"updated_at": "<string>",
"workflows_config": {}
},
"server_group_id": "123e4567-e89b-12d3-a456-426614174000",
"server_id": "123e4567-e89b-12d3-a456-426614174000",
"serverhost_id": "123e4567-e89b-12d3-a456-426614174000",
"state": "AVAILABLE",
"updated_at": "2023-01-01T12:00:00Z"
}
}Partially update an existing server
curl --request PATCH \
--url https://controller.platform.simplecloud.app/v0/servers \
--header 'Content-Type: application/json' \
--header 'X-Network-ID: <x-network-id>' \
--header 'X-Network-Secret: <x-network-secret>' \
--data '{}'{
"server": {
"cpu_usage": 25.5,
"created_at": "2023-01-01T12:00:00Z",
"ip": "127.0.0.1",
"last_activity": "2023-01-01T12:00:00Z",
"max_memory": 2048,
"max_players": 20,
"memory_usage": 512,
"min_memory": 1024,
"network_id": "123e4567-e89b-12d3-a456-426614174000",
"numerical_id": 1,
"persistent_server": {
"active": true,
"created_at": "<string>",
"id": "<string>",
"max_memory": 123,
"max_players": 123,
"min_memory": 123,
"name": "<string>",
"properties": {},
"serverhost_id": "<string>",
"source": {
"blueprint": "123e4567-e89b-12d3-a456-426614174000",
"image": "ghcr.io/user/custom-image:latest",
"type": "blueprint"
},
"tags": [
"<string>"
],
"type": "<string>",
"updated_at": "<string>",
"workflows": {
"manual": [
"<string>"
],
"when": {
"start": [
"<string>"
],
"stop": [
"<string>"
]
}
}
},
"persistent_server_id": "123e4567-e89b-12d3-a456-426614174000",
"player_count": 5,
"port": 25565,
"properties": {},
"server_group": {
"created_at": "<string>",
"deployment_config": {},
"deployment_strategy": "<string>",
"id": "<string>",
"name": "<string>",
"properties": {},
"scaling_config": {},
"source": {
"blueprint": {
"configurator": "<string>",
"created_at": "<string>",
"id": "<string>",
"minecraft_version": "<string>",
"name": "<string>",
"runtime_config": {},
"server_software": "<string>",
"server_url": "<string>",
"software_version": "<string>",
"updated_at": "<string>",
"workflow_steps": [
"<string>"
]
},
"image": "<string>",
"type": "<string>"
},
"tags": [
"<string>"
],
"type": "<string>",
"updated_at": "<string>",
"workflows_config": {}
},
"server_group_id": "123e4567-e89b-12d3-a456-426614174000",
"server_id": "123e4567-e89b-12d3-a456-426614174000",
"serverhost_id": "123e4567-e89b-12d3-a456-426614174000",
"state": "AVAILABLE",
"updated_at": "2023-01-01T12:00:00Z"
}
}Server ID
Server fields to update
The body is of type object.
OK
Response for patching a server
Summary of a server for listing
Show child attributes
Was this page helpful?