Getting basic information from every Guest

Owned by Sergio L. Pascual (Unlicensed)
Nov 17, 2016
1 min read

Format

MethodGET
URL

/guests

Request contentsEmpty
Successful answerBasicGuestInfo Object Array
Non-successful answerErrorMessage Object
Unexpected errorHTTP 500

 

BasicGuestInfo Object

Schema

guest_idStringGuest's unique identifier
guest_typeStringGuest type. Either "normal", "template" or "clone"
pool_idStringPool's unique identifier, to where this Guest has been assigned.
desired_stateString

Guest's desired state. Either "running", "stopped", "paused" or "suspended"

current_stateStringGuest's current state. Either "unknown", "running", "stopped", "paused", "suspended" or "migrating"
current_hostStringHost's unique identifier, where this Guest is currently running. Can be empty

JSON example

 

{
    "desired_state": "running",
    "current_state": "running",
    "current_host": "",
    "guest_type": "clone",
    "guest_id": "opensuse421_public-volatile-e30ca1bb",
    "pool_id": "demo_public"
}