Kubernetes clusters

Get autopilot savings

Returns what CostGraph AutoPilot saved and added across all clusters for a period, one entry per UTC hour, day or month clipped to the period, plus the period total. Saved and added are cost AutoPilot removed from or added to the managed workloads’ cost (by sizing and by pool placement), not bill savings. Dollars are null when the cost behind them could not be priced; not_priced_containers counts those containers. hours is the number of hours with recorded data in each entry, so a partial entry is visible. Only workloads AutoPilot currently runs on (managed, limited, learning or rolled back) are counted, including their earlier history; savings of workloads it no longer runs on are left out. Coverage counts managed workloads and managed pod-hours, including periods where AutoPilot changed nothing; workloads saved, added and unchanged can sum to less than managed workloads, because a workload whose cost could not be priced or nets exactly zero is in none of them. from and to are RFC 3339 and truncated to the hour, to is exclusive; the default is the last 30 days ending at the last closed hour; a period over 400 days is rejected, and hour granularity is limited to 31 days. Optional filters narrow the figures to one cluster, workload, container, node, node pool or GPU model.

GET

api

tenant

autopilot

savings

Get autopilot savings

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

import requests

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

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/autopilot/savings', 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/autopilot/savings",
  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/autopilot/savings"

	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/autopilot/savings")
  .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/autopilot/savings")

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": {
    "from": "<string>",
    "granularity": "<string>",
    "periods": [
      {
        "added": {
          "cpu_core_hours": 123,
          "gpu_hours": [
            {
              "hours": 123,
              "model": "<string>"
            }
          ],
          "memory_gib_hours": 123,
          "placement_usd": 123,
          "sizing_usd": 123,
          "usd": 123
        },
        "coverage": {
          "managed_pod_hours": 123,
          "managed_workloads": 123,
          "workloads_added": 123,
          "workloads_saved": 123,
          "workloads_unchanged": 123
        },
        "end": "<string>",
        "hours": 123,
        "not_priced_containers": 123,
        "saved": {
          "cpu_core_hours": 123,
          "gpu_hours": [
            {
              "hours": 123,
              "model": "<string>"
            }
          ],
          "memory_gib_hours": 123,
          "placement_usd": 123,
          "sizing_usd": 123,
          "usd": 123
        },
        "start": "<string>"
      }
    ],
    "to": "<string>",
    "total": {
      "added": {
        "cpu_core_hours": 123,
        "gpu_hours": [
          {
            "hours": 123,
            "model": "<string>"
          }
        ],
        "memory_gib_hours": 123,
        "placement_usd": 123,
        "sizing_usd": 123,
        "usd": 123
      },
      "coverage": {
        "managed_pod_hours": 123,
        "managed_workloads": 123,
        "workloads_added": 123,
        "workloads_saved": 123,
        "workloads_unchanged": 123
      },
      "end": "<string>",
      "hours": 123,
      "not_priced_containers": 123,
      "saved": {
        "cpu_core_hours": 123,
        "gpu_hours": [
          {
            "hours": 123,
            "model": "<string>"
          }
        ],
        "memory_gib_hours": 123,
        "placement_usd": 123,
        "sizing_usd": 123,
        "usd": 123
      },
      "start": "<string>"
    }
  }
}

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

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

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

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

{
  "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

Period start (RFC 3339, inclusive)

string

Period end (RFC 3339, exclusive)

granularity

string

Entry size: hour, day (default) or month

cluster_id

string

Only this Kubernetes cluster

workload_id

string

Only this workload resource ID

container

string

Only containers with this name

node_id

string

Only containers on this node (node ID)

pool_autoscaler

string

Only node pools of this autoscaler

pool

string

Only this node pool

gpu_model

string

Only containers on nodes with this GPU model

Response

message

string

required

Example:

"some message"

status

string

required

Example:

"success"

data

object

Show child attributes

Get autopilot savings

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

import requests

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

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/autopilot/savings', 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/autopilot/savings",
  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/autopilot/savings"

	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/autopilot/savings")
  .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/autopilot/savings")

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": {
    "from": "<string>",
    "granularity": "<string>",
    "periods": [
      {
        "added": {
          "cpu_core_hours": 123,
          "gpu_hours": [
            {
              "hours": 123,
              "model": "<string>"
            }
          ],
          "memory_gib_hours": 123,
          "placement_usd": 123,
          "sizing_usd": 123,
          "usd": 123
        },
        "coverage": {
          "managed_pod_hours": 123,
          "managed_workloads": 123,
          "workloads_added": 123,
          "workloads_saved": 123,
          "workloads_unchanged": 123
        },
        "end": "<string>",
        "hours": 123,
        "not_priced_containers": 123,
        "saved": {
          "cpu_core_hours": 123,
          "gpu_hours": [
            {
              "hours": 123,
              "model": "<string>"
            }
          ],
          "memory_gib_hours": 123,
          "placement_usd": 123,
          "sizing_usd": 123,
          "usd": 123
        },
        "start": "<string>"
      }
    ],
    "to": "<string>",
    "total": {
      "added": {
        "cpu_core_hours": 123,
        "gpu_hours": [
          {
            "hours": 123,
            "model": "<string>"
          }
        ],
        "memory_gib_hours": 123,
        "placement_usd": 123,
        "sizing_usd": 123,
        "usd": 123
      },
      "coverage": {
        "managed_pod_hours": 123,
        "managed_workloads": 123,
        "workloads_added": 123,
        "workloads_saved": 123,
        "workloads_unchanged": 123
      },
      "end": "<string>",
      "hours": 123,
      "not_priced_containers": 123,
      "saved": {
        "cpu_core_hours": 123,
        "gpu_hours": [
          {
            "hours": 123,
            "model": "<string>"
          }
        ],
        "memory_gib_hours": 123,
        "placement_usd": 123,
        "sizing_usd": 123,
        "usd": 123
      },
      "start": "<string>"
    }
  }
}

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

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

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

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

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

Getting started

Endpoints

Get autopilot savings

Authorizations

Headers

Query Parameters

Response