Skip to main content
PATCH
/
v0
/
serverhosts
/
deactivate
Deactivate or reactivate a serverhost
curl --request PATCH \
  --url https://controller.platform.simplecloud.app/v0/serverhosts/deactivate \
  --header 'Content-Type: application/json' \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>' \
  --data '{}'
{
  "deactivated": true,
  "deactivated_at": "2023-01-01T12:00:00Z",
  "host_name": "ServerHost-1",
  "message": "Serverhost deactivated successfully",
  "serverhost_id": "123e4567-e89b-12d3-a456-426614174000"
}

Headers

X-Network-ID
string
required

Network ID

X-Network-Secret
string
required

Network Secret

Query Parameters

serverhost_id
string
required

Serverhost ID

Body

application/json

Deactivation status

The body is of type object.

Response

OK

Response for serverhost deactivation operation

deactivated
boolean
Example:

true

deactivated_at
string
Example:

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

host_name
string
Example:

"ServerHost-1"

message
string
Example:

"Serverhost deactivated successfully"

serverhost_id
string
Example:

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