voxel.voxservers.status

Check the status of a VoxSERVER.

Parameters

device_id (optional)
Numeric Voxel device id, available from voxel.devices.list
verbosity (optional)
Verbosity of response. Should be one of "compact", "normal", or "extended".

Example Response

<rsp stat="ok">
  <devices>
    <device>
      <id>1234</id>
      <last_update>1235386846</last_update>
      <status>SUCCEEDED</status>
    </device>
  </devices>
</rsp>

Notes

This method will query the VoxSERVER infrastructure for your server's status. Possible values include: IN_PROGRESS (server is in the process of provisioning); SUCCEEDED (server provisioning is complete); FAILED (server provisioning failed; contact Voxel support for help). If the verbosity parameter is set to "extended", an extended_status value with details of the current provisioning step is also returned.

Method Specific Error Codes

100: Unknown device
The device_id passed in can't be matched to a valid device.
110: Incorrect device type
This device is of a type different than required by this method.