Skip to main content
POST
/
v0
/
server-groups
/
stop-all
Stop all servers in a group
curl --request POST \
  --url https://controller.platform.simplecloud.app/v0/server-groups/stop-all \
  --header 'Content-Type: application/json' \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>' \
  --data '{}'
{
  "message": "Stop command sent to all servers",
  "server_group_id": "123e4567-e89b-12d3-a456-426614174000",
  "servers_stopped": 5
}

Headers

​
X-Network-ID
string
required

Network ID

​
X-Network-Secret
string
required

Network Secret

Query Parameters

​
server_group_id
string
required

Server Group ID

Body

application/json

The body is of type object.

Response

OK

Response for stopping all servers in a server group

​
message
string
Example:

"Stop command sent to all servers"

​
server_group_id
string
Example:

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

​
servers_stopped
integer
Example:

5