Skip to content
Olivares AI docs

finops module route (requires finops:budget:read)

GET
/v1/m/finops/budgets/{id}/status
 
curl --request GET \
  --url https://example.com/v1/m/finops/budgets/example/status \
  --header 'Authorization: Bearer <token>'

Returns the live consumption of one budget against its limit.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string

Path parameter id.

Header Parameters

Section titled “ Header Parameters ”
X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Tenant-scoped financial evidence; legacy numeric fields are classified separately. Forecast is not certified.

Media type application/json
object
action
required
string
amount
object
causes
Array<string>
class
required
string
Allowed values: exact lower_bound unknown
components
required
object
cost
required
object
causes
Array<string>
pages_read
integer
rows_read
integer
state
required
string
Allowed values: known unknown nonnegative_unknown indeterminate
value_micro_usd
required

Canonical integer micro-USD, without floating-point conversion.

string | null
/^(0|-?[1-9][0-9]*)$/
dynamic_reservation
required
object
causes
Array<string>
pages_read
integer
rows_read
integer
state
required
string
Allowed values: known unknown nonnegative_unknown indeterminate
value_micro_usd
required

Canonical integer micro-USD, without floating-point conversion.

string | null
/^(0|-?[1-9][0-9]*)$/
static_reservation
required
object
causes
Array<string>
pages_read
integer
rows_read
integer
state
required
string
Allowed values: known unknown nonnegative_unknown indeterminate
value_micro_usd
required

Canonical integer micro-USD, without floating-point conversion.

string | null
/^(0|-?[1-9][0-9]*)$/
currency
required
string
effective_micro_usd
required

Canonical integer micro-USD, without floating-point conversion.

string | null
/^(0|-?[1-9][0-9]*)$/
forecast_certified
required
boolean
legacy_fields
required
object
over
required
string
Allowed values: proven not_reached unproven
projected_micro_usd
required
string
Allowed values: exact lower_bound unavailable
remaining_micro_usd
required
string
Allowed values: exact lower_bound unavailable
spend_micro_usd
required
string
Allowed values: exact lower_bound unavailable
legacy_projection
required
string
Allowed values: exact lower_bound unavailable
over_limit
required
object
causes
Array<string>
legacy_threshold_pct
integer
result
required
string
Allowed values: proven not_reached unproven
target_micro_usd
string
threshold
required
string
remaining_micro_usd
required

Canonical integer micro-USD, without floating-point conversion.

string | null
/^(0|-?[1-9][0-9]*)$/
state
required
string
Allowed values: complete incomplete
thresholds
required
Array<object> | null
object
causes
Array<string>
legacy_threshold_pct
integer
result
required
string
Allowed values: proven not_reached unproven
target_micro_usd
string
threshold
required
string
consumed_pct
required
integer
currency
required
string
dimension
required
string
enabled
required
boolean
exhaustion_confidence
string
exhaustion_days_remaining
required
integer
id
required
string
key
string
limit_micro_usd
required
integer format: int64
name
required
string
over
required
boolean
period
required
string
period_start
string
projected_micro_usd
required
integer format: int64
projected_pct
required
integer
remaining_micro_usd
required
integer format: int64
reserved_micro_usd
integer format: int64
samples
required
integer
spend_micro_usd
required
integer format: int64
truncated
boolean
Example 
{
  "amount": {
    "class": "exact",
    "components": {
      "cost": {
        "state": "known"
      },
      "dynamic_reservation": {
        "state": "known"
      },
      "static_reservation": {
        "state": "known"
      }
    },
    "forecast_certified": false,
    "legacy_fields": {
      "over": "proven",
      "projected_micro_usd": "exact",
      "remaining_micro_usd": "exact",
      "spend_micro_usd": "exact"
    },
    "legacy_projection": "exact",
    "over_limit": {
      "result": "proven"
    },
    "state": "complete",
    "thresholds": [
      {
        "result": "proven"
      }
    ]
  }
}

400

Section titled “ 400 ”

Bad request

Media type application/json
object
Example generated 
{}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
Example generated 
{}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
Example generated 
{}

404

Section titled “ 404 ”

Not found

Media type application/json
object
Example generated 
{}

409

Section titled “ 409 ”

Conflict / setup required

Media type application/json
object
Example generated 
{}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
Example generated 
{}

500

Section titled “ 500 ”

Store or evaluation failure

Media type application/json
object
Example generated 
{}