API Reference
Get recommendations for disks
Get the cheapest disk candidate per provider with savings versus the requested disk
POST
/
recommendations
/
disks
Get recommendations for disks
curl --request POST \
--url https://pricing.baselinehq.cloud/recommendations/disks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"include_metadata": true,
"instance": {
"availability_zone": "<string>",
"capacity_gb": 123,
"fallback_to_base_pricing": true,
"id": "<string>",
"iops": 123,
"region": "<string>",
"throughput_mbps": 123,
"type": "<string>"
},
"predicates": {
"availability_zones": [
"<string>"
],
"disk_types": [
"<string>"
],
"instance_types": [
"<string>"
],
"operating_systems": [
"<string>"
],
"providers": [
"<string>"
],
"regions": [
"<string>"
],
"services": [
"<string>"
],
"usage_types": [
"<string>"
]
},
"usage": {
"availability_zone": "<string>",
"capacity_gb": 123,
"fallback_to_base_pricing": true,
"id": "<string>",
"iops": 123,
"region": "<string>",
"throughput_mbps": 123,
"type": "<string>"
}
}
'import requests
url = "https://pricing.baselinehq.cloud/recommendations/disks"
payload = {
"include_metadata": True,
"instance": {
"availability_zone": "<string>",
"capacity_gb": 123,
"fallback_to_base_pricing": True,
"id": "<string>",
"iops": 123,
"region": "<string>",
"throughput_mbps": 123,
"type": "<string>"
},
"predicates": {
"availability_zones": ["<string>"],
"disk_types": ["<string>"],
"instance_types": ["<string>"],
"operating_systems": ["<string>"],
"providers": ["<string>"],
"regions": ["<string>"],
"services": ["<string>"],
"usage_types": ["<string>"]
},
"usage": {
"availability_zone": "<string>",
"capacity_gb": 123,
"fallback_to_base_pricing": True,
"id": "<string>",
"iops": 123,
"region": "<string>",
"throughput_mbps": 123,
"type": "<string>"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
include_metadata: true,
instance: {
availability_zone: '<string>',
capacity_gb: 123,
fallback_to_base_pricing: true,
id: '<string>',
iops: 123,
region: '<string>',
throughput_mbps: 123,
type: '<string>'
},
predicates: {
availability_zones: ['<string>'],
disk_types: ['<string>'],
instance_types: ['<string>'],
operating_systems: ['<string>'],
providers: ['<string>'],
regions: ['<string>'],
services: ['<string>'],
usage_types: ['<string>']
},
usage: {
availability_zone: '<string>',
capacity_gb: 123,
fallback_to_base_pricing: true,
id: '<string>',
iops: 123,
region: '<string>',
throughput_mbps: 123,
type: '<string>'
}
})
};
fetch('https://pricing.baselinehq.cloud/recommendations/disks', 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://pricing.baselinehq.cloud/recommendations/disks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'include_metadata' => true,
'instance' => [
'availability_zone' => '<string>',
'capacity_gb' => 123,
'fallback_to_base_pricing' => true,
'id' => '<string>',
'iops' => 123,
'region' => '<string>',
'throughput_mbps' => 123,
'type' => '<string>'
],
'predicates' => [
'availability_zones' => [
'<string>'
],
'disk_types' => [
'<string>'
],
'instance_types' => [
'<string>'
],
'operating_systems' => [
'<string>'
],
'providers' => [
'<string>'
],
'regions' => [
'<string>'
],
'services' => [
'<string>'
],
'usage_types' => [
'<string>'
]
],
'usage' => [
'availability_zone' => '<string>',
'capacity_gb' => 123,
'fallback_to_base_pricing' => true,
'id' => '<string>',
'iops' => 123,
'region' => '<string>',
'throughput_mbps' => 123,
'type' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pricing.baselinehq.cloud/recommendations/disks"
payload := strings.NewReader("{\n \"include_metadata\": true,\n \"instance\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n },\n \"predicates\": {\n \"availability_zones\": [\n \"<string>\"\n ],\n \"disk_types\": [\n \"<string>\"\n ],\n \"instance_types\": [\n \"<string>\"\n ],\n \"operating_systems\": [\n \"<string>\"\n ],\n \"providers\": [\n \"<string>\"\n ],\n \"regions\": [\n \"<string>\"\n ],\n \"services\": [\n \"<string>\"\n ],\n \"usage_types\": [\n \"<string>\"\n ]\n },\n \"usage\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pricing.baselinehq.cloud/recommendations/disks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"include_metadata\": true,\n \"instance\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n },\n \"predicates\": {\n \"availability_zones\": [\n \"<string>\"\n ],\n \"disk_types\": [\n \"<string>\"\n ],\n \"instance_types\": [\n \"<string>\"\n ],\n \"operating_systems\": [\n \"<string>\"\n ],\n \"providers\": [\n \"<string>\"\n ],\n \"regions\": [\n \"<string>\"\n ],\n \"services\": [\n \"<string>\"\n ],\n \"usage_types\": [\n \"<string>\"\n ]\n },\n \"usage\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pricing.baselinehq.cloud/recommendations/disks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"include_metadata\": true,\n \"instance\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n },\n \"predicates\": {\n \"availability_zones\": [\n \"<string>\"\n ],\n \"disk_types\": [\n \"<string>\"\n ],\n \"instance_types\": [\n \"<string>\"\n ],\n \"operating_systems\": [\n \"<string>\"\n ],\n \"providers\": [\n \"<string>\"\n ],\n \"regions\": [\n \"<string>\"\n ],\n \"services\": [\n \"<string>\"\n ],\n \"usage_types\": [\n \"<string>\"\n ]\n },\n \"usage\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body[
{
"pricing": {
"availability_zone": "<string>",
"cost_per_gb_hour": 123,
"cost_per_iops_hour": 123,
"cost_per_throughput_mbps_hour": 123,
"created_at": "<string>",
"id": "<string>",
"max_capacity_gb": 123,
"max_iops": 123,
"max_throughput_mbps": 123,
"min_capacity_gb": 123,
"min_iops": 123,
"min_throughput_mbps": 123,
"period_billing_hours": 123,
"provider": "<string>",
"raw_pricing_data": {},
"region": "<string>",
"service": "<string>",
"tags": {},
"type": "<string>",
"updated_at": "<string>",
"usage_type": "<string>"
},
"savings": {
"amount_per_hour": 123,
"amount_per_month": 123,
"amount_per_year": 123,
"percentage": 123
}
}
]{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
ApiKeyAuthBearerAuth
API key with "bl_" prefix (e.g. "bl_<api_key>")
Body
application/json
Instance
Was this page helpful?
⌘I
Get recommendations for disks
curl --request POST \
--url https://pricing.baselinehq.cloud/recommendations/disks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"include_metadata": true,
"instance": {
"availability_zone": "<string>",
"capacity_gb": 123,
"fallback_to_base_pricing": true,
"id": "<string>",
"iops": 123,
"region": "<string>",
"throughput_mbps": 123,
"type": "<string>"
},
"predicates": {
"availability_zones": [
"<string>"
],
"disk_types": [
"<string>"
],
"instance_types": [
"<string>"
],
"operating_systems": [
"<string>"
],
"providers": [
"<string>"
],
"regions": [
"<string>"
],
"services": [
"<string>"
],
"usage_types": [
"<string>"
]
},
"usage": {
"availability_zone": "<string>",
"capacity_gb": 123,
"fallback_to_base_pricing": true,
"id": "<string>",
"iops": 123,
"region": "<string>",
"throughput_mbps": 123,
"type": "<string>"
}
}
'import requests
url = "https://pricing.baselinehq.cloud/recommendations/disks"
payload = {
"include_metadata": True,
"instance": {
"availability_zone": "<string>",
"capacity_gb": 123,
"fallback_to_base_pricing": True,
"id": "<string>",
"iops": 123,
"region": "<string>",
"throughput_mbps": 123,
"type": "<string>"
},
"predicates": {
"availability_zones": ["<string>"],
"disk_types": ["<string>"],
"instance_types": ["<string>"],
"operating_systems": ["<string>"],
"providers": ["<string>"],
"regions": ["<string>"],
"services": ["<string>"],
"usage_types": ["<string>"]
},
"usage": {
"availability_zone": "<string>",
"capacity_gb": 123,
"fallback_to_base_pricing": True,
"id": "<string>",
"iops": 123,
"region": "<string>",
"throughput_mbps": 123,
"type": "<string>"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
include_metadata: true,
instance: {
availability_zone: '<string>',
capacity_gb: 123,
fallback_to_base_pricing: true,
id: '<string>',
iops: 123,
region: '<string>',
throughput_mbps: 123,
type: '<string>'
},
predicates: {
availability_zones: ['<string>'],
disk_types: ['<string>'],
instance_types: ['<string>'],
operating_systems: ['<string>'],
providers: ['<string>'],
regions: ['<string>'],
services: ['<string>'],
usage_types: ['<string>']
},
usage: {
availability_zone: '<string>',
capacity_gb: 123,
fallback_to_base_pricing: true,
id: '<string>',
iops: 123,
region: '<string>',
throughput_mbps: 123,
type: '<string>'
}
})
};
fetch('https://pricing.baselinehq.cloud/recommendations/disks', 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://pricing.baselinehq.cloud/recommendations/disks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'include_metadata' => true,
'instance' => [
'availability_zone' => '<string>',
'capacity_gb' => 123,
'fallback_to_base_pricing' => true,
'id' => '<string>',
'iops' => 123,
'region' => '<string>',
'throughput_mbps' => 123,
'type' => '<string>'
],
'predicates' => [
'availability_zones' => [
'<string>'
],
'disk_types' => [
'<string>'
],
'instance_types' => [
'<string>'
],
'operating_systems' => [
'<string>'
],
'providers' => [
'<string>'
],
'regions' => [
'<string>'
],
'services' => [
'<string>'
],
'usage_types' => [
'<string>'
]
],
'usage' => [
'availability_zone' => '<string>',
'capacity_gb' => 123,
'fallback_to_base_pricing' => true,
'id' => '<string>',
'iops' => 123,
'region' => '<string>',
'throughput_mbps' => 123,
'type' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pricing.baselinehq.cloud/recommendations/disks"
payload := strings.NewReader("{\n \"include_metadata\": true,\n \"instance\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n },\n \"predicates\": {\n \"availability_zones\": [\n \"<string>\"\n ],\n \"disk_types\": [\n \"<string>\"\n ],\n \"instance_types\": [\n \"<string>\"\n ],\n \"operating_systems\": [\n \"<string>\"\n ],\n \"providers\": [\n \"<string>\"\n ],\n \"regions\": [\n \"<string>\"\n ],\n \"services\": [\n \"<string>\"\n ],\n \"usage_types\": [\n \"<string>\"\n ]\n },\n \"usage\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pricing.baselinehq.cloud/recommendations/disks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"include_metadata\": true,\n \"instance\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n },\n \"predicates\": {\n \"availability_zones\": [\n \"<string>\"\n ],\n \"disk_types\": [\n \"<string>\"\n ],\n \"instance_types\": [\n \"<string>\"\n ],\n \"operating_systems\": [\n \"<string>\"\n ],\n \"providers\": [\n \"<string>\"\n ],\n \"regions\": [\n \"<string>\"\n ],\n \"services\": [\n \"<string>\"\n ],\n \"usage_types\": [\n \"<string>\"\n ]\n },\n \"usage\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pricing.baselinehq.cloud/recommendations/disks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"include_metadata\": true,\n \"instance\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n },\n \"predicates\": {\n \"availability_zones\": [\n \"<string>\"\n ],\n \"disk_types\": [\n \"<string>\"\n ],\n \"instance_types\": [\n \"<string>\"\n ],\n \"operating_systems\": [\n \"<string>\"\n ],\n \"providers\": [\n \"<string>\"\n ],\n \"regions\": [\n \"<string>\"\n ],\n \"services\": [\n \"<string>\"\n ],\n \"usage_types\": [\n \"<string>\"\n ]\n },\n \"usage\": {\n \"availability_zone\": \"<string>\",\n \"capacity_gb\": 123,\n \"fallback_to_base_pricing\": true,\n \"id\": \"<string>\",\n \"iops\": 123,\n \"region\": \"<string>\",\n \"throughput_mbps\": 123,\n \"type\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body[
{
"pricing": {
"availability_zone": "<string>",
"cost_per_gb_hour": 123,
"cost_per_iops_hour": 123,
"cost_per_throughput_mbps_hour": 123,
"created_at": "<string>",
"id": "<string>",
"max_capacity_gb": 123,
"max_iops": 123,
"max_throughput_mbps": 123,
"min_capacity_gb": 123,
"min_iops": 123,
"min_throughput_mbps": 123,
"period_billing_hours": 123,
"provider": "<string>",
"raw_pricing_data": {},
"region": "<string>",
"service": "<string>",
"tags": {},
"type": "<string>",
"updated_at": "<string>",
"usage_type": "<string>"
},
"savings": {
"amount_per_hour": 123,
"amount_per_month": 123,
"amount_per_year": 123,
"percentage": 123
}
}
]{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}