Python (SDK)
import latitudesh_python_sdk
from latitudesh_python_sdk import Latitudesh
import os
with Latitudesh(
bearer=os.getenv("LATITUDESH_BEARER", ""),
) as latitudesh:
res = latitudesh.virtual_machines.show_virtual_machine_metrics(virtual_machine_id="<id>", metric=latitudesh_python_sdk.QueryParamMetric.MEMORY)
# Handle response
print(res)package main
import(
"context"
"os"
latitudeshgosdk "github.com/latitudesh/latitudesh-go-sdk"
"github.com/latitudesh/latitudesh-go-sdk/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := latitudeshgosdk.New(
latitudeshgosdk.WithSecurity(os.Getenv("LATITUDESH_BEARER")),
)
res, err := s.VirtualMachines.ShowVirtualMachineMetrics(ctx, "<id>", operations.MetricMemory, nil, nil)
if err != nil {
log.Fatal(err)
}
if res.VirtualMachineMetrics != nil {
// handle response
}
}import { Latitudesh } from "latitudesh-typescript-sdk";
const latitudesh = new Latitudesh({
bearer: process.env["LATITUDESH_BEARER"] ?? "",
});
async function run() {
const result = await latitudesh.virtualMachines.showVirtualMachineMetrics({
virtualMachineId: "<id>",
metric: "memory",
});
console.log(result);
}
run();curl --request GET \
--url https://api.latitude.sh/virtual_machines/{virtual_machine_id}/metrics \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.latitude.sh/virtual_machines/{virtual_machine_id}/metrics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.latitude.sh/virtual_machines/{virtual_machine_id}/metrics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.latitude.sh/virtual_machines/{virtual_machine_id}/metrics")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.latitude.sh/virtual_machines/{virtual_machine_id}/metrics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"step": "<string>",
"points": [
{
"timestamp": "2023-11-07T05:31:56Z",
"value": 123
}
]
}Virtual machines
Retrieve VM metrics
Retrieve a time series for a single metric of a Virtual Machine.
GET
/
virtual_machines
/
{virtual_machine_id}
/
metrics
Python (SDK)
import latitudesh_python_sdk
from latitudesh_python_sdk import Latitudesh
import os
with Latitudesh(
bearer=os.getenv("LATITUDESH_BEARER", ""),
) as latitudesh:
res = latitudesh.virtual_machines.show_virtual_machine_metrics(virtual_machine_id="<id>", metric=latitudesh_python_sdk.QueryParamMetric.MEMORY)
# Handle response
print(res)package main
import(
"context"
"os"
latitudeshgosdk "github.com/latitudesh/latitudesh-go-sdk"
"github.com/latitudesh/latitudesh-go-sdk/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := latitudeshgosdk.New(
latitudeshgosdk.WithSecurity(os.Getenv("LATITUDESH_BEARER")),
)
res, err := s.VirtualMachines.ShowVirtualMachineMetrics(ctx, "<id>", operations.MetricMemory, nil, nil)
if err != nil {
log.Fatal(err)
}
if res.VirtualMachineMetrics != nil {
// handle response
}
}import { Latitudesh } from "latitudesh-typescript-sdk";
const latitudesh = new Latitudesh({
bearer: process.env["LATITUDESH_BEARER"] ?? "",
});
async function run() {
const result = await latitudesh.virtualMachines.showVirtualMachineMetrics({
virtualMachineId: "<id>",
metric: "memory",
});
console.log(result);
}
run();curl --request GET \
--url https://api.latitude.sh/virtual_machines/{virtual_machine_id}/metrics \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.latitude.sh/virtual_machines/{virtual_machine_id}/metrics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.latitude.sh/virtual_machines/{virtual_machine_id}/metrics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.latitude.sh/virtual_machines/{virtual_machine_id}/metrics")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.latitude.sh/virtual_machines/{virtual_machine_id}/metrics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"step": "<string>",
"points": [
{
"timestamp": "2023-11-07T05:31:56Z",
"value": 123
}
]
}Authorizations
Path Parameters
Query Parameters
Available options:
cpu, memory, network, disk Available options:
5m, 15m, 1h, 24h Response
200 - application/vnd.api+json
Success
Available options:
cpu, memory, network, disk Available options:
5m, 15m, 1h, 24h Sampling interval between adjacent points (e.g. "15s", "1m")
Unit applied to every point value
Available options:
percent, bytes_per_second Show child attributes
Show child attributes
Was this page helpful?
⌘I