Sandboxes

List sandboxes

Sandboxes the team reported starting in the period, newest first, with their estimated cost computed as in the summary. decision explains how the provider was chosen when the sandbox was started with a decision_id from POST /api/v1/tenant/sandboxes/route: the team’s policy then, baseline_provider (the team’s first provider), the reason, expected_seconds, and every provider considered in the returned order with its price per hour, expected cost, benchmark start time and success rate, as the route endpoint returned them. Each candidate also has result, why the policy did or did not put it first: picked, eligible, not_priced, unreliable (success_rate below 0.95), too_slow (startup_p50_ms more than twice the first provider’s for cheapest, or past the balanced start-time limit) over_budget (expected_cost above the first provider’s, for fastest and balanced), no_start_time (no benchmark start time to compare with the first provider’s, for fastest and balanced) or no_saving (no cheaper than the first provider within the start-time limit, for balanced); result is null except for the picked provider when the order was not ranked (reasons off, no_size and baseline_not_priced). Once the sandbox has stopped, when it ran at the size the decision priced (decision vcpus and memory_mib), each candidate’s actual_cost_usd is what the sandbox’s run time would have cost there, rounded up to that provider’s billing increment and at least its minimum billed time; for the provider the sandbox ran on it equals cost_usd. outcome is failed_here when the sandbox ran on a provider other than the picked one, with outcome_provider the picked provider; it is too_costly when the sandbox ran on the picked provider but, for its actual run time, an eligible candidate would have cost less (cheapest) or the first provider would have cost less (fastest and balanced), with outcome_provider that cheaper provider; otherwise outcome is null. decision is null for a sandbox started without a decision_id, and once the decision has passed its retention of about 90 days. Defaults to the last 30 days; a period over 400 days is rejected.

GET

api

tenant

sandboxes

autopilot

runs

List sandboxes

curl --request GET \
  --url https://api.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs \
  --header 'Authorization: <api-key>' \
  --header 'X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>'

import requests

url = "https://api.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs"

headers = {
    "X-CostGraph-Tenant-ID": "<x-costgraph-tenant-id>",
    "Authorization": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-CostGraph-Tenant-ID': '<x-costgraph-tenant-id>', Authorization: '<api-key>'}
};

fetch('https://api.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs', 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.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs",
  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>",
    "X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>"
  ],
]);

$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.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs"

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

	req.Header.Add("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
	req.Header.Add("Authorization", "<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.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs")
  .header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs")

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

request = Net::HTTP::Get.new(url)
request["X-CostGraph-Tenant-ID"] = '<x-costgraph-tenant-id>'
request["Authorization"] = '<api-key>'

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

{
  "message": "some message",
  "status": "success",
  "data": {
    "items": [
      {
        "currency": "<string>",
        "default_size": true,
        "metadata": {},
        "provider": "<string>",
        "routed": true,
        "sandbox_id": "<string>",
        "seconds": 123,
        "started_at": "<string>",
        "baseline_cost_usd": 123,
        "baseline_price_per_hour": 123,
        "baseline_provider": "<string>",
        "cost_usd": 123,
        "decision": {
          "baseline_provider": "<string>",
          "candidates": [
            {
              "priced": true,
              "provider": "<string>",
              "actual_cost_usd": 123,
              "billing_increment_seconds": 123,
              "expected_cost": 123,
              "minimum_billed_seconds": 123,
              "price_per_hour": 123,
              "result": "picked",
              "sku": "<string>",
              "startup_p50_ms": 123,
              "success_rate": 123
            }
          ],
          "reason": "cheapest",
          "expected_seconds": 123,
          "memory_mib": 123,
          "policy": "cheapest",
          "vcpus": 123
        },
        "decision_id": "<string>",
        "memory_mib": 123,
        "outcome": "too_costly",
        "outcome_provider": "<string>",
        "price_per_hour": 123,
        "size_class": "<string>",
        "stopped_at": "<string>",
        "vcpus": 123
      }
    ],
    "limit": 123,
    "offset": 123,
    "total_count": 123
  }
}

{
  "message": "some message",
  "status": "error"
}

Authorizations

Authorization

string

header

required

Enter "Bearer {token}"

Headers

X-CostGraph-Tenant-ID

string

required

Tenant ID

Query Parameters

from

string

First day, YYYY-MM-DD

string

Day after the last day, YYYY-MM-DD

provider

string

Only sandboxes on this provider

limit

integer

Number of rows to return (default 50, max 200)

offset

integer

Rows to skip before returning results (default 0)

Response

message

string

required

Example:

"some message"

status

string

required

Example:

"success"

data

object

Show child attributes

List sandboxes

curl --request GET \
  --url https://api.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs \
  --header 'Authorization: <api-key>' \
  --header 'X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>'

import requests

url = "https://api.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs"

headers = {
    "X-CostGraph-Tenant-ID": "<x-costgraph-tenant-id>",
    "Authorization": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-CostGraph-Tenant-ID': '<x-costgraph-tenant-id>', Authorization: '<api-key>'}
};

fetch('https://api.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs', 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.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs",
  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>",
    "X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>"
  ],
]);

$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.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs"

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

	req.Header.Add("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
	req.Header.Add("Authorization", "<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.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs")
  .header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/tenant/sandboxes/autopilot/runs")

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

request = Net::HTTP::Get.new(url)
request["X-CostGraph-Tenant-ID"] = '<x-costgraph-tenant-id>'
request["Authorization"] = '<api-key>'

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

{
  "message": "some message",
  "status": "success",
  "data": {
    "items": [
      {
        "currency": "<string>",
        "default_size": true,
        "metadata": {},
        "provider": "<string>",
        "routed": true,
        "sandbox_id": "<string>",
        "seconds": 123,
        "started_at": "<string>",
        "baseline_cost_usd": 123,
        "baseline_price_per_hour": 123,
        "baseline_provider": "<string>",
        "cost_usd": 123,
        "decision": {
          "baseline_provider": "<string>",
          "candidates": [
            {
              "priced": true,
              "provider": "<string>",
              "actual_cost_usd": 123,
              "billing_increment_seconds": 123,
              "expected_cost": 123,
              "minimum_billed_seconds": 123,
              "price_per_hour": 123,
              "result": "picked",
              "sku": "<string>",
              "startup_p50_ms": 123,
              "success_rate": 123
            }
          ],
          "reason": "cheapest",
          "expected_seconds": 123,
          "memory_mib": 123,
          "policy": "cheapest",
          "vcpus": 123
        },
        "decision_id": "<string>",
        "memory_mib": 123,
        "outcome": "too_costly",
        "outcome_provider": "<string>",
        "price_per_hour": 123,
        "size_class": "<string>",
        "stopped_at": "<string>",
        "vcpus": 123
      }
    ],
    "limit": 123,
    "offset": 123,
    "total_count": 123
  }
}

{
  "message": "some message",
  "status": "error"
}

Getting started

Endpoints

List sandboxes

Authorizations

Headers

Query Parameters

Response