Harness · Schema

BudgetGroup

The Cloud Cost Budget Group definition

DevOpsGitOpsInternal Developer PortalLifecycleSoftware DeliveryCI/CDContinuous DeliveryContinuous Integration

Properties

Name Type Description
uuid string
accountId string
name string
budgetGroupMonthlyBreakdown object
period string
budgetGroupAmount number
customAlertMessage string
actualCost number
forecastCost number
lastMonthCost number
alertThresholds array
childEntities array
parentBudgetGroupId string
cascadeType string
startTime integer
endTime integer
budgetGroupHistory object
createdAt integer
lastUpdatedAt integer
createdBy object
lastUpdatedBy object
View JSON Schema on GitHub

JSON Schema

harness-budget-group-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/harness/main/json-schema/harness-budget-group-schema.json",
  "title": "BudgetGroup",
  "description": "The Cloud Cost Budget Group definition",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/harness-budget-groups-api-openapi.yml#/components/schemas/BudgetGroup",
  "type": "object",
  "properties": {
    "uuid": {
      "type": "string"
    },
    "accountId": {
      "type": "string"
    },
    "name": {
      "maxLength": 80,
      "minLength": 1,
      "type": "string"
    },
    "budgetGroupMonthlyBreakdown": {
      "$ref": "#/$defs/BudgetMonthlyBreakdown"
    },
    "period": {
      "type": "string",
      "enum": [
        "DAILY",
        "WEEKLY",
        "MONTHLY",
        "QUARTERLY",
        "YEARLY"
      ]
    },
    "budgetGroupAmount": {
      "type": "number",
      "format": "double"
    },
    "customAlertMessage": {
      "type": "string"
    },
    "actualCost": {
      "type": "number",
      "format": "double"
    },
    "forecastCost": {
      "type": "number",
      "format": "double"
    },
    "lastMonthCost": {
      "type": "number",
      "format": "double"
    },
    "alertThresholds": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AlertThreshold"
      }
    },
    "childEntities": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/BudgetGroupChildEntityDTO"
      }
    },
    "parentBudgetGroupId": {
      "type": "string"
    },
    "cascadeType": {
      "type": "string",
      "enum": [
        "EQUAL",
        "PROPORTIONAL",
        "NO_CASCADE"
      ]
    },
    "startTime": {
      "type": "integer",
      "format": "int64"
    },
    "endTime": {
      "type": "integer",
      "format": "int64"
    },
    "budgetGroupHistory": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/BudgetCostData"
      }
    },
    "createdAt": {
      "type": "integer",
      "format": "int64"
    },
    "lastUpdatedAt": {
      "type": "integer",
      "format": "int64"
    },
    "createdBy": {
      "$ref": "#/$defs/EmbeddedUser"
    },
    "lastUpdatedBy": {
      "$ref": "#/$defs/EmbeddedUser"
    }
  },
  "$defs": {
    "AlertThreshold": {
      "type": "object",
      "properties": {
        "percentage": {
          "type": "number",
          "format": "double"
        },
        "basedOn": {
          "type": "string",
          "description": "Whether the alert is based on Actual cost or next 30 days Forecasted Cost",
          "enum": [
            "ACTUAL_COST",
            "FORECASTED_COST",
            "PARTIAL_COST",
            "YEARLY_ACTUAL_COST",
            "YEARLY_FORECASTED_COST"
          ]
        },
        "emailAddresses": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "userGroupIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "slackWebhooks": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "alertsSent": {
          "type": "integer",
          "format": "int32"
        },
        "crossedAt": {
          "type": "integer",
          "format": "int64"
        }
      },
      "description": "A description of a single Alert"
    },
    "BudgetCostData": {
      "type": "object",
      "properties": {
        "time": {
          "type": "integer",
          "format": "int64"
        },
        "endTime": {
          "type": "integer",
          "format": "int64"
        },
        "actualCost": {
          "type": "number",
          "format": "double"
        },
        "forecastCost": {
          "type": "number",
          "format": "double"
        },
        "budgeted": {
          "type": "number",
          "format": "double"
        },
        "budgetVariance": {
          "type": "number",
          "format": "double"
        },
        "budgetVariancePercentage": {
          "type": "number",
          "format": "double"
        }
      }
    },
    "BudgetGroupChildEntityDTO": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "proportion": {
          "type": "number",
          "format": "double"
        },
        "isBudgetGroup": {
          "type": "boolean",
          "writeOnly": true
        },
        "budgetGroup": {
          "type": "boolean"
        }
      }
    },
    "BudgetMonthlyBreakdown": {
      "type": "object",
      "properties": {
        "budgetBreakdown": {
          "type": "string",
          "description": "Whether the Yearly budget breakdown is yearly or monthly",
          "enum": [
            "YEARLY",
            "MONTHLY"
          ]
        },
        "budgetMonthlyAmount": {
          "type": "array",
          "description": "Budgeted monthly amount for yearly budget",
          "items": {
            "$ref": "#/$defs/ValueDataPoint"
          }
        },
        "actualMonthlyCost": {
          "type": "array",
          "description": "Actual monthly cost for yearly budget",
          "items": {
            "type": "number",
            "description": "Actual monthly cost for yearly budget",
            "format": "double"
          }
        },
        "forecastMonthlyCost": {
          "type": "array",
          "description": "Forecasted monthly cost for yearly budget",
          "items": {
            "type": "number",
            "description": "Forecasted monthly cost for yearly budget",
            "format": "double"
          }
        },
        "yearlyLastPeriodCost": {
          "type": "array",
          "description": "Yearly monthly cost for last year budget",
          "items": {
            "type": "number",
            "description": "Yearly monthly cost for last year budget",
            "format": "double"
          }
        },
        "forecastCostConfigured": {
          "type": "boolean",
          "description": "Indicates whether forecast cost has been ingested by the user"
        }
      },
      "description": "The budget monthly breakdown of a Yearly Budget"
    },
    "EmbeddedUser": {
      "type": "object",
      "properties": {
        "uuid": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "externalUserId": {
          "type": "string"
        }
      }
    },
    "ValueDataPoint": {
      "type": "object",
      "properties": {
        "time": {
          "type": "integer",
          "format": "int64"
        },
        "value": {
          "type": "number",
          "format": "double"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/harness-budget-group"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.