> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.ibee.co.in/docs/api-reference/cloud-vms/list-cloud-vms/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ibee.co.in/_mcp/server. # List cloud VMs GET https://api.ibee.co.in/v1/compute/cloud-vms Returns all cloud VMs in the workspace. Requires scope: vm.read. Reference: https://docs.ibee.co.in/docs/api-reference/cloud-vms/list-cloud-vms ## Authentication - `Authorization` header (bearer token, required) — IBEE platform API token. Production tokens start with `ibee_prod_key_`; development tokens start with `ibee_dev_key_`. Use a token only with its matching gateway environment. ## Servers - `https://api.ibee.co.in/v1` (Production, default) - `https://api.ibee.co.in/v1` (Development) ## Request ### Query parameters - `workspace_id` (string, required) — The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected. ## Response ### 200 Cloud VMs returned successfully. - `list of CloudVm` ## Errors ### 401 Unauthorized Error The API token is missing or invalid. - `detail` (ErrorDetail, optional) ### 403 Forbidden Error The token is not allowed to access the workspace or does not have the required scope. - `detail` (ErrorDetail, optional) ## Types ### CloudVm - `id` (string, optional) - `name` (string, optional) - `status` (enum, optional) - Allowed values: `pending`, `creating`, `provisioning`, `configuring`, `running`, `starting`, `stopping`, `stopped`, `rebooting`, `resizing`, `attaching_volume`, `detaching_volume`, `resizing_plan`, `resizing_disk`, `deleting`, `deleted`, `error` - `cpu` (integer, optional) - `ram_mb` (integer, optional) - `disk_gb` (integer, optional) - `os_type` (string, optional) - `os_distro` (string, optional) - `plan_name` (string, optional, nullable) - `public_ip` (string, optional, nullable) - `private_ip` (string, optional, nullable) - `tags` (list of string, optional) - `created_at` (datetime, optional) - `updated_at` (datetime, optional, nullable) ### ErrorDetail ## Examples **Response** ```json [ { "id": "vm_abc123", "name": "web-server-01", "status": "running", "cpu": 2, "ram_mb": 4096, "disk_gb": 80, "os_type": "linux", "os_distro": "ubuntu", "plan_name": "standard-2x4", "public_ip": "103.149.10.42", "private_ip": "10.0.1.15", "tags": [ "string" ], "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z" } ] ``` **SDK Code** ```python import requests url = "https://api.ibee.co.in/v1/compute/cloud-vms" querystring = {"workspace_id":"710995"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.ibee.co.in/v1/compute/cloud-vms?workspace_id=710995'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.ibee.co.in/v1/compute/cloud-vms?workspace_id=710995" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.ibee.co.in/v1/compute/cloud-vms?workspace_id=710995") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.ibee.co.in/v1/compute/cloud-vms?workspace_id=710995") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.ibee.co.in/v1/compute/cloud-vms?workspace_id=710995', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.ibee.co.in/v1/compute/cloud-vms?workspace_id=710995"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.ibee.co.in/v1/compute/cloud-vms?workspace_id=710995")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```