> 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/get-cloud-vm-metrics/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ibee.co.in/_mcp/server.

# Get cloud VM metrics

GET https://api.ibee.co.in/v1/compute/cloud-vms/{vm_id}/metrics

Returns current resource-usage metrics for a cloud VM. Requires scope: vm.read.

Reference: https://docs.ibee.co.in/docs/api-reference/cloud-vms/get-cloud-vm-metrics

## 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

### Path parameters

- `vm_id` (string, required) — Virtual machine ID.

### 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

VM metrics returned successfully.

- `vm_id` (string, required)
- `vm_type` (enum, required)
  - Allowed values: `cloud`, `gpu`
- `power_state` (string, required)
- `monitoring_status` (enum, required)
  - Allowed values: `active`, `stale`, `unavailable`
- `month_rx_bytes` (integer, required, default: 0)
- `month_tx_bytes` (integer, required, default: 0)
- `last_collected_at` (datetime, optional, nullable)
- `cpu_percent` (double, optional, nullable)
- `memory_used_bytes` (integer, optional, nullable)
- `memory_used_percent` (double, optional, nullable)
- `storage_used_bytes` (integer, optional, nullable)
- `storage_total_bytes` (integer, optional, nullable)
- `storage_used_percent` (double, optional, nullable)
- `storage_provisioned_bytes` (integer, optional, nullable)
- `disk_read_bps` (double, optional, nullable)
- `disk_write_bps` (double, optional, nullable)
- `disk_read_iops` (double, optional, nullable)
- `disk_write_iops` (double, optional, nullable)
- `net_rx_bps` (double, optional, nullable)
- `net_tx_bps` (double, optional, nullable)

## 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)

### 404 Not Found Error

The requested resource was not found.

- `detail` (ErrorDetail, optional)

## Types

### ErrorDetail

## Examples

**Response**

```json
{
  "vm_id": "string",
  "vm_type": "cloud",
  "power_state": "string",
  "monitoring_status": "active",
  "month_rx_bytes": 0,
  "month_tx_bytes": 0,
  "last_collected_at": "2024-01-15T09:30:00Z",
  "cpu_percent": 45.2,
  "memory_used_bytes": 1,
  "memory_used_percent": 67.8,
  "storage_used_bytes": 1,
  "storage_total_bytes": 1,
  "storage_used_percent": 1.1,
  "storage_provisioned_bytes": 1,
  "disk_read_bps": 1.1,
  "disk_write_bps": 1.1,
  "disk_read_iops": 1.1,
  "disk_write_iops": 1.1,
  "net_rx_bps": 1.1,
  "net_tx_bps": 1.1
}
```

**SDK Code**

```python
import requests

url = "https://api.ibee.co.in/v1/compute/cloud-vms/vm_id/metrics"

querystring = {"workspace_id":"710995"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.ibee.co.in/v1/compute/cloud-vms/vm_id/metrics?workspace_id=710995';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/vm_id/metrics?workspace_id=710995"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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/vm_id/metrics?workspace_id=710995")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.ibee.co.in/v1/compute/cloud-vms/vm_id/metrics?workspace_id=710995")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.ibee.co.in/v1/compute/cloud-vms/vm_id/metrics?workspace_id=710995', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.ibee.co.in/v1/compute/cloud-vms/vm_id/metrics?workspace_id=710995");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.ibee.co.in/v1/compute/cloud-vms/vm_id/metrics?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()
```