Skip to content

Replace virtual machine shutdown wait time

PUT
/vm/{rid}/options/shutdown-wait-time
curl --request PUT \
--url https://sylve.lan:8181/api/vm/1/options/shutdown-wait-time \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "waitTime": 1 }'

Set how long a graceful virtual machine shutdown may wait before forced termination

rid
required
integer
>= 1

Virtual Machine RID

Shutdown wait-time configuration

Media typeapplication/json
object
waitTime
required
integer
Examplegenerated
{
"waitTime": 1
}

Success

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Request Entity Too Large

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
"data": "example",
"error": "example",
"message": "example",
"status": "example"
}