Skip to main content
POST
Stop a HPE Morpheus cluster

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id
string<uuid>
required

Query Parameters

force
enum<string>

'true' to cancel every operation and tear the cluster down now, without a capture.

Available options:
true,
false
preserve_state
enum<string>

'true' to require a state capture before teardown, 'false' to tear down without one. Omitted captures whenever the cluster supports it.

Available options:
true,
false
mode
enum<string>

delete_resources (default) removes the VMs; pause powers them off and keeps them.

Available options:
delete_resources,
pause

Response

Cluster stop initiated

success
boolean
required
cluster_id
string<uuid>
required
operation_id
string<uuid> | null
required
state_preserved
boolean
required

True when the stop first captures an encrypted etcd snapshot and tears the cluster down only once it is in the vault; the next start restores it.

stop_mode
enum<string>
required

What the stop does to the VMs: pause powers them off and keeps them, delete_resources removes them.

Available options:
pause,
delete_resources
state_snapshot
object

The capture to follow, present when state_preserved is true.

message
string

Why the stop could not preserve state, or what a preserving stop does next.