Skip to main content
PATCH
/
api
/
servers
/
{serverId}
Control server state (start/stop)
curl --request PATCH \
  --url https://api.example.com/api/servers/{serverId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "start"
}
'
{
  "data": {
    "id": "<string>",
    "status": "running",
    "startedAt": "2023-11-07T05:31:56Z",
    "stoppedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Enter your API key here

Path Parameters

​
serverId
string
required

ID of the server to control

Body

application/json
​
action
enum<string>
required
Available options:
start,
stop

Response

Server state changed successfully

​
data
object