Skip to main content
ZStack
Resource Center/Hardware/Host Operations

ShutdownHost

ShutdownHost

PUT/zstack/v1/hosts/power/{uuid}/actions

Operation ID

ShutdownHost

Since

4.7.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • uuid
    StringRequired

    The resource UUID.

Body Fields

  • returnEarly
    boolean

    Optional. Whether to make the result returned eralier.

  • force
    boolean

    Optional. Whether to forcefully power off the host.

  • method
    String

    Optional. The method to power off the host.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns an empty JSON object {}.