CommunityWebsiteDocumentationExchangeSupportDeveloper
HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

Stop a Host

put
https://{serverURL}/api/servers//stop

This will stop a host. To force a hard power off, include the query parameter force=true.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
required

The id or uuid to identify the server record.

The id of the server record.

Query Params
boolean
Defaults to false

Force stop by passing true. This performs a hard power off, bypassing a graceful shutdown of the guest operating system.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?