Skip to main content
POST
/
v0
/
serverhosts
/
register
Register a new serverhost
curl --request POST \
  --url https://controller.platform.simplecloud.app/v0/serverhosts/register \
  --header 'Content-Type: application/json' \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>' \
  --data '{}'
{
  "host_name": "ServerHost-1",
  "last_keep_alive": "2023-01-01T12:00:00Z",
  "maximum_memory": 8192,
  "message": "Serverhost registered successfully",
  "network_id": "123e4567-e89b-12d3-a456-426614174000",
  "serverhost_id": "123e4567-e89b-12d3-a456-426614174000"
}

Headers

​
X-Network-ID
string
required

Network ID

​
X-Network-Secret
string
required

Network Secret

Body

application/json

Serverhost details

The body is of type object.

Response

Created

Response for serverhost registration

​
host_name
string
Example:

"ServerHost-1"

​
last_keep_alive
string
Example:

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

​
maximum_memory
integer
Example:

8192

​
message
string
Example:

"Serverhost registered successfully"

​
network_id
string
Example:

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

​
serverhost_id
string
Example:

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