Update recommendation view

curl --request PUT \
  --url https://api.vantage.sh/v2/recommendation_views/{recommendation_view_token} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "provider_ids": [
    "<string>"
  ],
  "billing_account_ids": [
    "<string>"
  ],
  "account_ids": [
    "<string>"
  ],
  "regions": [
    "<string>"
  ],
  "types": [
    "<string>"
  ],
  "tag_key": "<string>",
  "tag_value": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "min_savings": 123
}
'

import requests

url = "https://api.vantage.sh/v2/recommendation_views/{recommendation_view_token}"

payload = {
    "title": "<string>",
    "provider_ids": ["<string>"],
    "billing_account_ids": ["<string>"],
    "account_ids": ["<string>"],
    "regions": ["<string>"],
    "types": ["<string>"],
    "tag_key": "<string>",
    "tag_value": "<string>",
    "start_date": "<string>",
    "end_date": "<string>",
    "min_savings": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    provider_ids: ['<string>'],
    billing_account_ids: ['<string>'],
    account_ids: ['<string>'],
    regions: ['<string>'],
    types: ['<string>'],
    tag_key: '<string>',
    tag_value: '<string>',
    start_date: '<string>',
    end_date: '<string>',
    min_savings: 123
  })
};

fetch('https://api.vantage.sh/v2/recommendation_views/{recommendation_view_token}', 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.vantage.sh/v2/recommendation_views/{recommendation_view_token}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'provider_ids' => [
        '<string>'
    ],
    'billing_account_ids' => [
        '<string>'
    ],
    'account_ids' => [
        '<string>'
    ],
    'regions' => [
        '<string>'
    ],
    'types' => [
        '<string>'
    ],
    'tag_key' => '<string>',
    'tag_value' => '<string>',
    'start_date' => '<string>',
    'end_date' => '<string>',
    'min_savings' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.vantage.sh/v2/recommendation_views/{recommendation_view_token}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"provider_ids\": [\n    \"<string>\"\n  ],\n  \"billing_account_ids\": [\n    \"<string>\"\n  ],\n  \"account_ids\": [\n    \"<string>\"\n  ],\n  \"regions\": [\n    \"<string>\"\n  ],\n  \"types\": [\n    \"<string>\"\n  ],\n  \"tag_key\": \"<string>\",\n  \"tag_value\": \"<string>\",\n  \"start_date\": \"<string>\",\n  \"end_date\": \"<string>\",\n  \"min_savings\": 123\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.vantage.sh/v2/recommendation_views/{recommendation_view_token}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"provider_ids\": [\n    \"<string>\"\n  ],\n  \"billing_account_ids\": [\n    \"<string>\"\n  ],\n  \"account_ids\": [\n    \"<string>\"\n  ],\n  \"regions\": [\n    \"<string>\"\n  ],\n  \"types\": [\n    \"<string>\"\n  ],\n  \"tag_key\": \"<string>\",\n  \"tag_value\": \"<string>\",\n  \"start_date\": \"<string>\",\n  \"end_date\": \"<string>\",\n  \"min_savings\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vantage.sh/v2/recommendation_views/{recommendation_view_token}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"provider_ids\": [\n    \"<string>\"\n  ],\n  \"billing_account_ids\": [\n    \"<string>\"\n  ],\n  \"account_ids\": [\n    \"<string>\"\n  ],\n  \"regions\": [\n    \"<string>\"\n  ],\n  \"types\": [\n    \"<string>\"\n  ],\n  \"tag_key\": \"<string>\",\n  \"tag_value\": \"<string>\",\n  \"start_date\": \"<string>\",\n  \"end_date\": \"<string>\",\n  \"min_savings\": 123\n}"

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

{
  "token": "rec_vw_be3f24eb1b5aabf6",
  "title": "Updated Recommendations View",
  "workspace_token": "wrkspc_be6568a301b1d06c",
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "provider_ids": [
    "aws",
    "gcp",
    "azure"
  ],
  "billing_account_ids": [],
  "account_ids": [
    "123456789012",
    "987654321098"
  ],
  "regions": [
    "us-east-1",
    "us-west-2",
    "ap-northeast-2"
  ],
  "tag_key": "environment",
  "tag_value": "production",
  "created_at": "2024-07-15T16:08:54Z",
  "created_by": "team_73f6001f98e9012b"
}

{
  "errors": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "last": "<string>",
    "prev": "<string>"
  }
}

{
  "errors": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "last": "<string>",
    "prev": "<string>"
  }
}

{
  "errors": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "last": "<string>",
    "prev": "<string>"
  }
}

PUT

recommendation_views

{recommendation_view_token}

Update recommendation view

curl --request PUT \
  --url https://api.vantage.sh/v2/recommendation_views/{recommendation_view_token} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "provider_ids": [
    "<string>"
  ],
  "billing_account_ids": [
    "<string>"
  ],
  "account_ids": [
    "<string>"
  ],
  "regions": [
    "<string>"
  ],
  "types": [
    "<string>"
  ],
  "tag_key": "<string>",
  "tag_value": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "min_savings": 123
}
'

import requests

url = "https://api.vantage.sh/v2/recommendation_views/{recommendation_view_token}"

payload = {
    "title": "<string>",
    "provider_ids": ["<string>"],
    "billing_account_ids": ["<string>"],
    "account_ids": ["<string>"],
    "regions": ["<string>"],
    "types": ["<string>"],
    "tag_key": "<string>",
    "tag_value": "<string>",
    "start_date": "<string>",
    "end_date": "<string>",
    "min_savings": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    provider_ids: ['<string>'],
    billing_account_ids: ['<string>'],
    account_ids: ['<string>'],
    regions: ['<string>'],
    types: ['<string>'],
    tag_key: '<string>',
    tag_value: '<string>',
    start_date: '<string>',
    end_date: '<string>',
    min_savings: 123
  })
};

fetch('https://api.vantage.sh/v2/recommendation_views/{recommendation_view_token}', 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.vantage.sh/v2/recommendation_views/{recommendation_view_token}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'provider_ids' => [
        '<string>'
    ],
    'billing_account_ids' => [
        '<string>'
    ],
    'account_ids' => [
        '<string>'
    ],
    'regions' => [
        '<string>'
    ],
    'types' => [
        '<string>'
    ],
    'tag_key' => '<string>',
    'tag_value' => '<string>',
    'start_date' => '<string>',
    'end_date' => '<string>',
    'min_savings' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.vantage.sh/v2/recommendation_views/{recommendation_view_token}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"provider_ids\": [\n    \"<string>\"\n  ],\n  \"billing_account_ids\": [\n    \"<string>\"\n  ],\n  \"account_ids\": [\n    \"<string>\"\n  ],\n  \"regions\": [\n    \"<string>\"\n  ],\n  \"types\": [\n    \"<string>\"\n  ],\n  \"tag_key\": \"<string>\",\n  \"tag_value\": \"<string>\",\n  \"start_date\": \"<string>\",\n  \"end_date\": \"<string>\",\n  \"min_savings\": 123\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.vantage.sh/v2/recommendation_views/{recommendation_view_token}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"provider_ids\": [\n    \"<string>\"\n  ],\n  \"billing_account_ids\": [\n    \"<string>\"\n  ],\n  \"account_ids\": [\n    \"<string>\"\n  ],\n  \"regions\": [\n    \"<string>\"\n  ],\n  \"types\": [\n    \"<string>\"\n  ],\n  \"tag_key\": \"<string>\",\n  \"tag_value\": \"<string>\",\n  \"start_date\": \"<string>\",\n  \"end_date\": \"<string>\",\n  \"min_savings\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vantage.sh/v2/recommendation_views/{recommendation_view_token}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"provider_ids\": [\n    \"<string>\"\n  ],\n  \"billing_account_ids\": [\n    \"<string>\"\n  ],\n  \"account_ids\": [\n    \"<string>\"\n  ],\n  \"regions\": [\n    \"<string>\"\n  ],\n  \"types\": [\n    \"<string>\"\n  ],\n  \"tag_key\": \"<string>\",\n  \"tag_value\": \"<string>\",\n  \"start_date\": \"<string>\",\n  \"end_date\": \"<string>\",\n  \"min_savings\": 123\n}"

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

{
  "token": "rec_vw_be3f24eb1b5aabf6",
  "title": "Updated Recommendations View",
  "workspace_token": "wrkspc_be6568a301b1d06c",
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "provider_ids": [
    "aws",
    "gcp",
    "azure"
  ],
  "billing_account_ids": [],
  "account_ids": [
    "123456789012",
    "987654321098"
  ],
  "regions": [
    "us-east-1",
    "us-west-2",
    "ap-northeast-2"
  ],
  "tag_key": "environment",
  "tag_value": "production",
  "created_at": "2024-07-15T16:08:54Z",
  "created_by": "team_73f6001f98e9012b"
}

{
  "errors": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "last": "<string>",
    "prev": "<string>"
  }
}

{
  "errors": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "last": "<string>",
    "prev": "<string>"
  }
}

{
  "errors": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "last": "<string>",
    "prev": "<string>"
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials

Token URL: https://console.vantage.sh/account/profile

Scopes1

write

Grants write access

Path Parameters

recommendation_view_token

string

required

Body

application/json

Update a RecommendationView.

title

string

The title of the RecommendationView.

provider_ids

string[]

Filter by one or more providers (e.g. aws, gcp, azure, kubernetes, datadog).

billing_account_ids

string[]

Filter by billing account identifiers.

account_ids

string[]

Filter by cloud account identifiers.

regions

string[]

Filter by region slugs (e.g. us-east-1, eastus, asia-east1).

types

string[]

Filter by one or more recommendation type slugs.

tag_key

string

Filter by tag key (must be used with tag_value).

tag_value

string

Filter by tag value (requires tag_key).

start_date

string

Filter recommendations created on/after this YYYY-MM-DD date.

end_date

string

Filter recommendations created on/before this YYYY-MM-DD date.

min_savings

number<float>

Filter recommendations with at least this amount of potential savings.

Response

RecommendationView model

token

string | null

title

string | null

The title of the RecommendationView.

Example:

"Production Recommendations"

workspace_token

string | null

The token for the Workspace the RecommendationView is a part of.

start_date

string | null

Filter recommendations created on/after this YYYY-MM-DD date.

Example:

"2024-01-01"

end_date

string | null

Filter recommendations created on/before this YYYY-MM-DD date.

Example:

"2024-12-31"

provider_ids

string[] | null

Filter by one or more providers.

billing_account_ids

string[] | null

Filter by billing account identifiers.

account_ids

string[] | null

Filter by cloud account identifiers.

regions

string[] | null

Filter by region slugs (e.g. us-east-1, eastus, asia-east1).

types

string[] | null

Filter by one or more recommendation type slugs.

tag_key

string | null

Filter by tag key (must be used with tag_value).

Example:

"environment"

tag_value

string | null

Filter by tag value (requires tag_key).

Example:

"production"

min_savings

number<float> | null

Filter recommendations with at least this amount of potential savings.

Example:

100.5

created_at

string | null

The date and time, in UTC, the view was created. ISO 8601 Formatted.

Example:

"2023-08-04T00:00:00Z"

created_by

string | null

The token for the Creator of this RecommendationView.

Getting Started

About the API

API Reference

OpenAPI Specification

Update recommendation view

Authorizations

Path Parameters

Body

Response