curl --request GET \
--url https://api.stg.simnet.cloud/api/v1/compute/instances/all \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stg.simnet.cloud/api/v1/compute/instances/all"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.stg.simnet.cloud/api/v1/compute/instances/all', 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.stg.simnet.cloud/api/v1/compute/instances/all",
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: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.stg.simnet.cloud/api/v1/compute/instances/all"
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(string(body))
}HttpResponse<String> response = Unirest.get("https://api.stg.simnet.cloud/api/v1/compute/instances/all")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stg.simnet.cloud/api/v1/compute/instances/all")
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{
"virtualmachines": [
{
"id": "<string>",
"name": "<string>",
"displayName": "<string>",
"state": "<string>",
"instanceType": "<string>",
"cpuNumber": 123,
"cpuSpeed": 123,
"memoryKbs": 123,
"hypervisor": "<string>",
"ipAddress": "<string>",
"networkKbsRead": 123,
"networkKbsWrite": 123,
"receivedBytes": 123,
"sentBytes": 123,
"diskKbsRead": 123,
"diskKbsWrite": 123,
"diskIoRead": 123,
"diskIoWrite": 123,
"osDisplayName": "<string>",
"haEnabled": true,
"deleteProtection": true,
"created": "2023-11-07T05:31:56Z",
"lastUpdated": "2023-11-07T05:31:56Z",
"account": "<string>",
"domain": "<string>",
"tags": {},
"details": {},
"cpuUtilization": "<string>",
"memoryUtilization": "<string>",
"templateId": "<string>",
"templateName": "<string>",
"templateType": "<string>",
"templateFormat": "<string>",
"templateDisplayText": "<string>",
"serviceOfferingId": "<string>",
"serviceOfferingName": "<string>",
"diskOfferingId": "<string>",
"diskOfferingName": "<string>",
"zoneId": "<string>",
"zoneName": "<string>",
"hostId": "<string>",
"hostname": "<string>",
"hostControlState": "<string>",
"memory": 123,
"cpuTotal": "<string>",
"memoryTotal": "<string>",
"instanceName": "<string>",
"passwordEnabled": true,
"displayVm": true,
"isDynamicallyScalable": true,
"userId": "<string>",
"username": "<string>",
"domainId": "<string>",
"guestOsId": "<string>",
"osTypeId": "<string>",
"rootDeviceId": 123,
"rootDeviceType": "<string>",
"bootMode": "<string>",
"bootType": "<string>",
"poolType": "<string>",
"arch": "<string>",
"hasAnnotations": true,
"backupOfferingId": "<string>",
"backupOfferingName": "<string>"
}
],
"count": 123,
"totalElements": 123,
"currentPage": 123,
"page": 123,
"pageSize": 123,
"totalPages": 123,
"hasNext": true,
"hasPrevious": true
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}Get All Instances
GET /api/v1/compute/instances/all
curl --request GET \
--url https://api.stg.simnet.cloud/api/v1/compute/instances/all \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stg.simnet.cloud/api/v1/compute/instances/all"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.stg.simnet.cloud/api/v1/compute/instances/all', 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.stg.simnet.cloud/api/v1/compute/instances/all",
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: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.stg.simnet.cloud/api/v1/compute/instances/all"
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(string(body))
}HttpResponse<String> response = Unirest.get("https://api.stg.simnet.cloud/api/v1/compute/instances/all")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stg.simnet.cloud/api/v1/compute/instances/all")
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{
"virtualmachines": [
{
"id": "<string>",
"name": "<string>",
"displayName": "<string>",
"state": "<string>",
"instanceType": "<string>",
"cpuNumber": 123,
"cpuSpeed": 123,
"memoryKbs": 123,
"hypervisor": "<string>",
"ipAddress": "<string>",
"networkKbsRead": 123,
"networkKbsWrite": 123,
"receivedBytes": 123,
"sentBytes": 123,
"diskKbsRead": 123,
"diskKbsWrite": 123,
"diskIoRead": 123,
"diskIoWrite": 123,
"osDisplayName": "<string>",
"haEnabled": true,
"deleteProtection": true,
"created": "2023-11-07T05:31:56Z",
"lastUpdated": "2023-11-07T05:31:56Z",
"account": "<string>",
"domain": "<string>",
"tags": {},
"details": {},
"cpuUtilization": "<string>",
"memoryUtilization": "<string>",
"templateId": "<string>",
"templateName": "<string>",
"templateType": "<string>",
"templateFormat": "<string>",
"templateDisplayText": "<string>",
"serviceOfferingId": "<string>",
"serviceOfferingName": "<string>",
"diskOfferingId": "<string>",
"diskOfferingName": "<string>",
"zoneId": "<string>",
"zoneName": "<string>",
"hostId": "<string>",
"hostname": "<string>",
"hostControlState": "<string>",
"memory": 123,
"cpuTotal": "<string>",
"memoryTotal": "<string>",
"instanceName": "<string>",
"passwordEnabled": true,
"displayVm": true,
"isDynamicallyScalable": true,
"userId": "<string>",
"username": "<string>",
"domainId": "<string>",
"guestOsId": "<string>",
"osTypeId": "<string>",
"rootDeviceId": 123,
"rootDeviceType": "<string>",
"bootMode": "<string>",
"bootType": "<string>",
"poolType": "<string>",
"arch": "<string>",
"hasAnnotations": true,
"backupOfferingId": "<string>",
"backupOfferingName": "<string>"
}
],
"count": 123,
"totalElements": 123,
"currentPage": 123,
"page": 123,
"pageSize": 123,
"totalPages": 123,
"hasNext": true,
"hasPrevious": true
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}{
"message": "Operation failed",
"timestamp": "2023-11-07T05:31:56Z",
"detail": "Unable to find a suitable host"
}Authorizations
The access token from a signed-in console session, sent as Authorization: Bearer <token>. It must be issued for the Simnet API audience — an identity token, or a token for another application, is refused with 401.
There are no API keys, client secrets or service accounts yet, so this is a personal, short-lived credential carrying your full account access. Programmatic credentials with role-based access are on the roadmap. See Authentication.
Headers
Query Parameters
Response
Success. Rows are under virtualmachines.
Recovered from the code that builds this response. Rows arrive under virtualmachines — the compute platform's own key, not content.
The rows, under virtualmachines.
Show child attributes
Show child attributes
Total rows matching the query.
Same value as count.
Same value as page.
The page you are on, counting from 1.
Rows per page.
Number of pages.