Skip to main content

Shutdown virtual machine

POST 

/virtual_machines/virtual_machine/shutdown

Queues a task to shutdown a virtual machine

Scopes

  • virtual_machines
  • virtual_machines:power_actions

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Body

    virtual_machine

    object

    required

    All 'virtual_machine[]' params are mutually exclusive, only one can be provided.

    id string
    fqdn string

Responses

Queues a task to shutdown a virtual machine

Schema

    task

    object

    required

    id string
    name string
    status TaskStatusEnum (string)

    Possible values: [pending, running, completed, failed]

Loading...