curl --request GET \
--url https://api.instabox.sh/v1/operations/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.instabox.sh/v1/operations/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.instabox.sh/v1/operations/{id}', 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.instabox.sh/v1/operations/{id}",
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.instabox.sh/v1/operations/{id}"
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.instabox.sh/v1/operations/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.instabox.sh/v1/operations/{id}")
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{
"id": "<string>",
"machineId": "<string>",
"type": "create",
"state": "queued",
"error": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"phase": "<string>",
"forkInherited": true,
"trigger": "idle",
"machine": {
"id": "<string>",
"name": "<string>",
"desiredState": "creating",
"state": "creating",
"revision": 123,
"operationId": "<string>",
"template": {
"id": "<string>",
"version": "<string>",
"digest": "<string>",
"kernel": "<string>"
},
"spec": {
"vcpus": 123,
"memMiB": 123,
"persistentDiskGiB": 123,
"rootDiskGiB": 123
},
"storage": {
"sizeGiB": 123,
"mountPath": "/data",
"persistent": true,
"synced": true,
"snapshotSeq": 123
},
"runtime": {
"ready": true,
"processesPreserved": true
},
"autoSuspendAfterSeconds": 123,
"maxRunMinutes": 1073741823,
"runStartedAt": "2023-11-07T05:31:56Z",
"cooldownUntil": "2023-11-07T05:31:56Z",
"metadata": {},
"vault": true,
"guestUser": "alice",
"orgId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"snapshot": {
"id": "<string>"
},
"image": {
"id": "<string>"
},
"lastError": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
},
"archiveAt": "2023-11-07T05:31:56Z",
"deleteAt": "2023-11-07T05:31:56Z",
"readyAt": "2023-11-07T05:31:56Z",
"cooldownReason": "abuse_egress_blocklist",
"abuseLock": {
"at": "2023-11-07T05:31:56Z",
"explanation": "<string>",
"what": "<string>",
"appeal": "<string>",
"dst": "<string>",
"port": 123,
"kind": "<string>",
"count": 123,
"coreShare": 123,
"process": "<string>",
"pool": "<string>"
},
"autoSuspendedAt": "2023-11-07T05:31:56Z",
"envNames": [
"<string>"
],
"free": true,
"earlyAllowanceEnded": true,
"oomKills": 123,
"lastOom": {
"at": "2023-11-07T05:31:56Z",
"pid": 123,
"process": "<string>",
"rssBytes": 123,
"anonRssBytes": 123,
"cgroup": true,
"uid": 123
}
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
}
}Get an operation (the progress of a sandbox change).
API keys: needs one of the scopes machines:read, images:read.
With wait, a long poll: the response comes as soon as the operation is succeeded or failed, or its state or phase differs from what it was when the request arrived, or when the wait ends, whichever is first; it is always the operation as it is then. Loop on it instead of polling at an interval. A done operation answers at once.
curl --request GET \
--url https://api.instabox.sh/v1/operations/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.instabox.sh/v1/operations/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.instabox.sh/v1/operations/{id}', 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.instabox.sh/v1/operations/{id}",
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.instabox.sh/v1/operations/{id}"
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.instabox.sh/v1/operations/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.instabox.sh/v1/operations/{id}")
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{
"id": "<string>",
"machineId": "<string>",
"type": "create",
"state": "queued",
"error": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"phase": "<string>",
"forkInherited": true,
"trigger": "idle",
"machine": {
"id": "<string>",
"name": "<string>",
"desiredState": "creating",
"state": "creating",
"revision": 123,
"operationId": "<string>",
"template": {
"id": "<string>",
"version": "<string>",
"digest": "<string>",
"kernel": "<string>"
},
"spec": {
"vcpus": 123,
"memMiB": 123,
"persistentDiskGiB": 123,
"rootDiskGiB": 123
},
"storage": {
"sizeGiB": 123,
"mountPath": "/data",
"persistent": true,
"synced": true,
"snapshotSeq": 123
},
"runtime": {
"ready": true,
"processesPreserved": true
},
"autoSuspendAfterSeconds": 123,
"maxRunMinutes": 1073741823,
"runStartedAt": "2023-11-07T05:31:56Z",
"cooldownUntil": "2023-11-07T05:31:56Z",
"metadata": {},
"vault": true,
"guestUser": "alice",
"orgId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"snapshot": {
"id": "<string>"
},
"image": {
"id": "<string>"
},
"lastError": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
},
"archiveAt": "2023-11-07T05:31:56Z",
"deleteAt": "2023-11-07T05:31:56Z",
"readyAt": "2023-11-07T05:31:56Z",
"cooldownReason": "abuse_egress_blocklist",
"abuseLock": {
"at": "2023-11-07T05:31:56Z",
"explanation": "<string>",
"what": "<string>",
"appeal": "<string>",
"dst": "<string>",
"port": 123,
"kind": "<string>",
"count": 123,
"coreShare": 123,
"process": "<string>",
"pool": "<string>"
},
"autoSuspendedAt": "2023-11-07T05:31:56Z",
"envNames": [
"<string>"
],
"free": true,
"earlyAllowanceEnded": true,
"oomKills": 123,
"lastOom": {
"at": "2023-11-07T05:31:56Z",
"pid": 123,
"process": "<string>",
"rssBytes": 123,
"anonRssBytes": 123,
"cgroup": true,
"uid": 123
}
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"operationId": "<string>",
"reason": "missing_key",
"hint": "<string>",
"docs": "<string>",
"docs_url": "<string>",
"requiredScopes": [
"<string>"
],
"retryAfterSeconds": 2,
"at": "2023-11-07T05:31:56Z"
}
}Authorizations
Opaque instabox access token (1 hour). Refresh with /v1/auth/refresh (refresh token valid 30 days, rotates on use).
Path Parameters
Operation ID (op_…).
Query Parameters
Long-poll for up to this long: a duration such as 25s or 500ms, or whole seconds (25). Capped at 30s; absent or 0 answers at once.
"25s"
Response
The operation.
The progress of a change to a sandbox (suspend is pause; restore puts its disks back to a snapshot's; move, admin only, copies it to another host pool). It does not return the request it was queued with (a start's vcpus/memMiB show in the sandbox's spec).
create, start, stop, suspend, resume, delete, restore, resize, move succeeded and failed are terminal.
queued, running, succeeded, failed Show child attributes
Show child attributes
Free text progress, e.g. scheduling, booting, waiting_ready, snapshotting.
On the answer to POST /v1/machines/{id}/fork: the control host that took it keeps the source's delete deadline, idle auto-suspend, max run and metadata, and takes autoSuspendAfterSeconds and maxRunMinutes. Absent: a host from before that (during a rolling control deploy), which gave the fork its defaults with only the request's metadata and deleteAfterSeconds; set the idle auto-suspend and max run with PATCH /v1/machines/{id}.
Set when instabox started the operation itself: idle (paused when idle), max_run (maximum continuous runtime), memory_pressure (paused, its processes kept, because the host it ran on was running out of memory; the next use wakes it, as after idle), request (wake on use), wake (POST /v1/machines/{id}/wake), timeout, archive, delete_at (the sandbox's deleteAt passed), drain (maintenance by an admin), user_delete (an admin deleted the owner), user_disable (an admin disabled the owner), admin (an admin stopped or paused the sandbox), admin_delete (an admin deleted the sandbox), credit (its free-tier org used up the month's included usage), spend_cap, downgrade, subscription_ended, payment_method (its free workspace has no card on file), members (its free workspace has more members than the free plan allows), early_allowance_ended (paused because the account's early free-sandbox allowance ended and it has more free sandboxes than the free plan runs), abuse_pool (paused because the sandbox tried to connect to a blocked destination on the egress blocklist, such as a crypto-mining pool; a DNS lookup of a listed domain never suspends) or abuse_cpu (paused by the CPU abuse detector: a restricted account's sandbox ran flat out for an hour with no memory use, no public port, nobody using it and a connection to a mining port) or abuse_scan (paused by the flow detector: a restricted account's sandbox swept one port across many hosts, scanned many ports of one host or brute-forced a login port). Absent: a client request.
idle, max_run, memory_pressure, timeout, archive, delete_at, drain, request, wake, user_delete, user_disable, admin, admin_delete, credit, spend_cap, downgrade, subscription_ended, payment_method, members, early_allowance_ended, abuse_pool, abuse_cpu, abuse_scan, abuse_proxy The sandbox as it is when GET /v1/operations/{id} is read. Included when the operation succeeded, the sandbox still exists, and the caller may read sandboxes (machines:read for API keys). Later operations can change it; it is not a record of the state at completion. Absent otherwise, and from older servers.
Show child attributes
Show child attributes
Was this page helpful?