RArafftechnologies
Virtual Machines

List VMs

Changed on

List all virtual machines for the authenticated account.

get/api/v1/vms

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/vms
  • Auth
    API key in header X-API-Key

Query parameters

project_idstring uuid

Filter by project ID

region'us-east'

Filter by region

status'active' | 'passive' | 'provisioning' | 'booting' | 'initiating' | 'finalizing' | 'failure'

Filter by VM status. Values: initiating (queued/setup), provisioning (being created), booting (starting), active (running), passive (stopped), finalizing (shutting down), failure (failed).

limitinteger

Maximum number of VMs to return

offsetinteger

Number of VMs to skip for pagination

Response

List of VMs

successboolean

Whether the request was successful

totalinteger

Total number of VMs matching the query

Example response

{
  "data": [
    {
      "name": "my-ubuntu-server",
      "cpu": 2,
      "ram": 4,
      "storage": 80,
      "total_storage": 80,
      "template_name": "Ubuntu",
      "template_version": "24.10x64",
      "price_per_hour": "0.027764",
      "pricing_id": 3,
      "billing_type": "payg",
      "backup_type": "weekly",
      "region": "us-east",
      "public_ipv4_address": "15.204.178.3",
      "private_ipv4_address": "10.10.0.96"
    }
  ]
}

Changes

  • 5aa8dfc0e403Revision changes
    • info

      added the optional property // to the response with the status

  • 9e13a6e23934Revision changes
    • warning

      removed the optional property // from the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status