/v2/budgets

1 min

GET

https://dev-api.cloudzero.com/v2/budgets

Get a list of Budgets

Query Parameters

limitnumber<int32>
Description
Number of items to return per page
cursorstring
Description
Pass only this parameter to page forward or back; NOTE: remember to urlencode it!
sort_keybudget_sort_keys
Description
Sortable Budget properties
sort_ordersort_order
Description
ASC or DESC sort order
expandbudget_get_all_expand
Description
If passed, query will expand the properties specified. This is a multi-value query parameter, pass it more than once to specify multiple values, e.g. &expand=current&expand=history

Header Parameters

cloudzero-idempotency-keystring
Description
If passed, any subsequent operation with the same value for this header will return the exact same result. This is true for all responses, i.e. successes and errors.
cloudzero-test-keystring
Description
If passed, the operation executes in the namespace specified by this key. Resource mutations in the namespace last for 1 hour.

Responses

200Successful Operation

object
- paginationpagination
  Description
  Supports programmatic pagination
  - page_countinteger<int32>
  - item_countinteger<int32>
  - total_countinteger<int32>
  - cursorobject
    - next_cursorstring<nullable>
    - previous_cursorstring<nullable>
    - has_nextboolean
    - has_previousboolean
- sortingbudget_sorting
  - availableobject
    - sort_keysbudget_sort_keys[]
      Description
      Sortable Budget properties
    - sort_orderssort_orders
      Example
      [ "asc", "desc" ]
  - currentobject[]
    - sort_keybudget_sort_keys
      Description
      Sortable Budget properties
    - sort_ordersort_order
- budgetsbudget_maybe_current_expanded
  - budget
    - namestringrequired
      Description
      Budget name, must be unique within a View
    - planned_limitsbudget_planned_limitsrequired
      Example
      { "monthly": { "2022-02-01T00:00:00+00:00": { "amount": "1000.00" } } }
      Description
      Mapping of date to amount, where date is an ISO Formatted string amount is a Mapping of the literal string "amount" to a dollar amount
      - monthlymap<string, object>required
        Description
        Monthly planned limit as a mapping of month date to amount, where month date is an ISO Formatted Date [Time] String that will be coerced to the first of the month amount is a Mapping of the literal string "amount" to a dollar amount
    - viewwith_idrequired
      Description
      View associated with this Budget
      - idstringrequired
    - alertsbudget_alerts
      Example
      { "alerts": { "80": "N", "100": "Y" } }
      Description
      Mapping of 1-100 to Y/N, where 1-100 is the percentage of the budget at which to send an alert Y/N is whether or not to send the alert
    - idstringrequired
    - createdepochrequired
      Description
      UTC timestamp for the creation of this entity
    - last_updatedepochrequired
      Description
      UTC timestamp for the last update of this entity
    - cost_typecost_typerequired
      Description
      Type of charges included in the cost calculation, where real_cost: filters your bill to only display charges directly related to consumption
    - granularitygranularityrequired
      Description
      Supported periods, e.g. "monthly"
  - bb1
    - currentbbcrequired
      - actualstringrequired
      - plannedstringrequired

400Bad Request Error

object
- errorerror
  - messagestring
  - typestring

403Forbidden

object
- messagestringrequired

curl

curl --request GET \
     --url 'https://dev-api.cloudzero.com/v2/budgets?sort_key=object&sort_order=object&expand=object' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://dev-api.cloudzero.com/v2/budgets?sort_key=object&sort_order=object&expand=object", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://dev-api.cloudzero.com/v2/budgets?sort_key=object&sort_order=object&expand=object")

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

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "https://dev-api.cloudzero.com/v2/budgets?sort_key=object&sort_order=object&expand=object"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful Operation
{
  "pagination": {
    "page_count": "",
    "item_count": "",
    "total_count": "",
    "cursor": {
      "next_cursor": "",
      "previous_cursor": "",
      "has_next": false,
      "has_previous": false
    }
  },
  "sorting": {
    "available": {
      "sort_keys": [
        ""
      ],
      "sort_orders": [
        ""
      ]
    },
    "current": [
      {
        "sort_key": "",
        "sort_order": ""
      }
    ]
  },
  "budgets": {}
}

400

// Bad Request Error
{
  "error": {
    "message": "",
    "type": ""
  }
}

403

// Forbidden
{
  "message": ""
}