Skip to main content
GET
/
v0
/
serverhosts
List serverhosts
curl --request GET \
  --url https://controller.platform.simplecloud.app/v0/serverhosts \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>'
{
  "count": 5,
  "serverhosts": [
    {
      "created_at": "2023-01-01T12:00:00Z",
      "deactivated": false,
      "deactivated_at": "2023-01-01T12:00:00Z",
      "host_name": "ServerHost-1",
      "last_keep_alive": "2023-01-01T12:00:00Z",
      "maximum_memory": 8192,
      "network_id": "123e4567-e89b-12d3-a456-426614174000",
      "serverhost_id": "123e4567-e89b-12d3-a456-426614174000",
      "started_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-01T12:00:00Z"
    }
  ]
}

Headers

X-Network-ID
string
required

Network ID

X-Network-Secret
string
required

Network Secret

Query Parameters

active
boolean

Filter by active status (true = only active, false = only deactivated)

Response

OK

Response for listing serverhosts

count
integer
Example:

5

serverhosts
object[]