Master
Versions: Euwe / Fine / Latest /

Instance Management

Management of instances adds support for the following actions:

Action Description

start

Starts an Instance

stop

Stops an Instance

suspend

Suspending an Instance

pause

Pausing an Instance

reboot_guest

Rebooting Guest in an Instance

reset

Resetting an Instance

shelve

Shelving an Instance

terminate

Terminating an Instance

Targeting Instances

These actions can be triggered on individual instance resources:

/api/instances/:id

As simply as POSTing the following action to an instance.

{
  "action" : "start"
}

Requests can also be made on multiple instances by targeting the primary collection:

/api/instances
{
  "action" : "start",
  "resources" : [
    { "href" : "http://localhost:3000/api/instances/101" },
    { "href" : "http://localhost:3000/api/instances/102" },
    ...
  ]
}

Querying Instances

Instances are queried via the primary collection URL:

/api/instances

Filtering, sorting and paging as mentioned on the Querying page.

Load Balancers

Load Balancers of an instance can be queried via the load_balancers subcollection as follows:

Query all Load Balancers of an instance:

GET /api/instances/:id/load_balancers

Query a specific Load Balancer of an instance:

GET /api/instances/:id/load_balancers/:load_balancer_id

Or expanding the Load Balancers for the specific instance as follows:

GET /api/instances/:id?expand=load_balancers

Starting an Instance

{
  "action" : "start"
}

Stopping an Instance

{
  "action" : "stop"
}

Suspending an Instance

{
  "action" : "suspend"
}

Pausing an Instance

{
  "action" : "pause"
}

Terminating an Instance

{
  "action" : "terminate"
}

Shelving an Instance

{
  "action" : "shelve"
}

Rebooting Guest in an Instance

{
  "action" : "reboot-guest"
}

Resetting an Instance

{
  "action" : "reset"
}