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",
  "maximum_memory": 8192
}
'
import requests

url = "https://controller.platform.simplecloud.app/v0/serverhosts/register"

payload = {
    "host_name": "ServerHost-1",
    "maximum_memory": 8192
}
headers = {
    "X-Network-ID": "<x-network-id>",
    "X-Network-Secret": "<x-network-secret>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'X-Network-ID': '<x-network-id>',
    'X-Network-Secret': '<x-network-secret>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({host_name: 'ServerHost-1', maximum_memory: 8192})
};

fetch('https://controller.platform.simplecloud.app/v0/serverhosts/register', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://controller.platform.simplecloud.app/v0/serverhosts/register",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'host_name' => 'ServerHost-1',
    'maximum_memory' => 8192
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Network-ID: <x-network-id>",
    "X-Network-Secret: <x-network-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://controller.platform.simplecloud.app/v0/serverhosts/register"

	payload := strings.NewReader("{\n  \"host_name\": \"ServerHost-1\",\n  \"maximum_memory\": 8192\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Network-ID", "<x-network-id>")
	req.Header.Add("X-Network-Secret", "<x-network-secret>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://controller.platform.simplecloud.app/v0/serverhosts/register")
  .header("X-Network-ID", "<x-network-id>")
  .header("X-Network-Secret", "<x-network-secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"host_name\": \"ServerHost-1\",\n  \"maximum_memory\": 8192\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://controller.platform.simplecloud.app/v0/serverhosts/register")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Network-ID"] = '<x-network-id>'
request["X-Network-Secret"] = '<x-network-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"host_name\": \"ServerHost-1\",\n  \"maximum_memory\": 8192\n}"

response = http.request(request)
puts response.read_body
{
  "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"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}

Headers

X-Network-ID
string
required

Network ID

X-Network-Secret
string
required

Network Secret

Body

application/json

Serverhost details

Request for serverhost registration

host_name
string
Example:

"ServerHost-1"

maximum_memory
integer
Example:

8192

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"