Skip to main content
DELETE
/
api
/
v3
/
servers
/
{instance_id}
Stop a server
curl --request DELETE \
  --url https://playflow.dev/api/api/v3/servers/{instance_id} \
  --header 'api-key: <api-key>'
{
  "status": "<string>"
}

Authorizations

​
api-key
string
header
required

Path Parameters

​
instance_id
string
required

Server instance ID to stop.

Query Parameters

​
shutdown_reason
string

Reason for stopping the server. Used for analytics and debugging. Common values: PROCESS_EXITED, TTL_EXPIRED, SHUTDOWN_SIGNAL, STARTUP_FAILURE_URL, STARTUP_FAILURE_DOWNLOAD, STARTUP_FAILURE_EXECUTABLE.

Response

Server stop initiated. Status is updated immediately; machine cleanup happens in the background.

Response returned after successfully stopping a server.

​
status
string
required

Confirmation message, e.g., "Server stopped successfully".