Read the cloud computer fleet
curl --request GET \
--url https://api.openworklabs.com/v1/admin/computer-fleet \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/computer-fleet"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/admin/computer-fleet', 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.openworklabs.com/v1/admin/computer-fleet",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.openworklabs.com/v1/admin/computer-fleet"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.openworklabs.com/v1/admin/computer-fleet")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/computer-fleet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "not_configured",
"generatedAt": "2023-11-07T05:31:56Z",
"runnerError": "<string>",
"sources": [
{
"source": "gateway",
"provider": "<string>",
"status": "ok",
"error": "<string>",
"truncated": true,
"pools": [
{
"name": "<string>",
"backend": "<string>",
"region": "<string>",
"enabled": true,
"health": "<string>"
}
],
"counts": {
"total": 4503599627370495,
"running": 4503599627370495,
"paused": 4503599627370495,
"attention": 4503599627370495
},
"settings": {
"image": "<string>",
"idlePauseSeconds": 4503599627370495,
"keepDays": 4503599627370495,
"persistent": true
}
}
],
"sandboxes": [
{
"id": "<string>",
"source": "gateway",
"provider": "<string>",
"pool": "<string>",
"backend": "<string>",
"region": "<string>",
"state": "starting",
"status": "<string>",
"statusReason": "<string>",
"attention": "failed",
"cpu": 4503599627370495,
"memoryMb": 4503599627370495,
"diskGb": 4503599627370495,
"createdAt": "2023-11-07T05:31:56Z",
"lastChangedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"pausedAt": "2023-11-07T05:31:56Z",
"lastActivityAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"organization": {
"id": "<string>",
"name": "<string>"
},
"image": "<string>",
"imageCurrent": null,
"runSeconds": 4503599627370495
}
],
"listTruncated": true,
"totals": {
"total": 4503599627370495,
"running": 4503599627370495,
"starting": 4503599627370495,
"pausing": 4503599627370495,
"paused": 4503599627370495,
"stopped": 4503599627370495,
"stopping": 4503599627370495,
"failed": 4503599627370495,
"attention": 4503599627370495
},
"attentionCounts": {
"failed": 0,
"stuck_starting": 0,
"stuck_pausing": 0,
"stuck_stopping": 0,
"expired": 0,
"idle_running": 0,
"long_running": 0
},
"organizations": [],
"unknownOrganization": 0
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}Admin
Read the cloud computer fleet
Pass organization (an organization id, or unknown) to list only that organization’s computers; totals, sources and the status stay the whole fleet’s. Every sandbox cloud conversations use as a computer, as its provider reports it now: what it is doing, where it runs (the sandbox gateway’s pool, or the direct provider), its size and times, which need a look, and whose it is. Read through the headless runner, which asks the providers with its own keys; readers within 15 seconds share one read. status is not_configured when there is no runner or it has no computers.
GET
/
v1
/
admin
/
computer-fleet
Read the cloud computer fleet
curl --request GET \
--url https://api.openworklabs.com/v1/admin/computer-fleet \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/computer-fleet"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/admin/computer-fleet', 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.openworklabs.com/v1/admin/computer-fleet",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.openworklabs.com/v1/admin/computer-fleet"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.openworklabs.com/v1/admin/computer-fleet")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/computer-fleet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "not_configured",
"generatedAt": "2023-11-07T05:31:56Z",
"runnerError": "<string>",
"sources": [
{
"source": "gateway",
"provider": "<string>",
"status": "ok",
"error": "<string>",
"truncated": true,
"pools": [
{
"name": "<string>",
"backend": "<string>",
"region": "<string>",
"enabled": true,
"health": "<string>"
}
],
"counts": {
"total": 4503599627370495,
"running": 4503599627370495,
"paused": 4503599627370495,
"attention": 4503599627370495
},
"settings": {
"image": "<string>",
"idlePauseSeconds": 4503599627370495,
"keepDays": 4503599627370495,
"persistent": true
}
}
],
"sandboxes": [
{
"id": "<string>",
"source": "gateway",
"provider": "<string>",
"pool": "<string>",
"backend": "<string>",
"region": "<string>",
"state": "starting",
"status": "<string>",
"statusReason": "<string>",
"attention": "failed",
"cpu": 4503599627370495,
"memoryMb": 4503599627370495,
"diskGb": 4503599627370495,
"createdAt": "2023-11-07T05:31:56Z",
"lastChangedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"pausedAt": "2023-11-07T05:31:56Z",
"lastActivityAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"organization": {
"id": "<string>",
"name": "<string>"
},
"image": "<string>",
"imageCurrent": null,
"runSeconds": 4503599627370495
}
],
"listTruncated": true,
"totals": {
"total": 4503599627370495,
"running": 4503599627370495,
"starting": 4503599627370495,
"pausing": 4503599627370495,
"paused": 4503599627370495,
"stopped": 4503599627370495,
"stopping": 4503599627370495,
"failed": 4503599627370495,
"attention": 4503599627370495
},
"attentionCounts": {
"failed": 0,
"stuck_starting": 0,
"stuck_pausing": 0,
"stuck_stopping": 0,
"expired": 0,
"idle_running": 0,
"long_running": 0
},
"organizations": [],
"unknownOrganization": 0
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}Authorizations
denApiKeybearerAuth
Response
The fleet now.
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Was this page helpful?