v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

budgetManagement

Creates a budget definition

Create a budget definition

post/v1/budgets

Request body

namestring required

Name of the budget.

capacityinteger required

Capacity of the budget.

unitstring required

Unit of the budget.

budgetTypestring required

Type of the budget.

windowstring required

Window of the budget. Use Daily/Weekly/Monthly for creating a time based budget (beta)

applicableOnstring required

Grouping of the budget.

groupBystring required

Grouping Entity of the budget.

actionstring required

Action to be taken if the budget is breached

statusstring

Signifies the state of the budget. (Active/Inactive)

Example request

{
  "unit": "GB",
  "budgetType": "ScanBudget",
  "scope": {
    "includedUsers": [
      "00000000000001DF",
      "00000000000002D2"
    ],
    "excludedUsers": [
      "00000000000001DF",
      "00000000000002D2"
    ],
    "includedRoles": [
      "00000000000001DF",
      "00000000000002D2"
    ],
    "excludedRoles": [
      "00000000000001DF",
      "00000000000002D2"
    ]
  },
  "window": "Query",
  "applicableOn": "PerEntity",
  "groupBy": "User",
  "action": "Warn",
  "status": "active"
}

Response

The created budget.

namestring required

Name of the budget.

capacityinteger required

Capacity of the budget.

unitstring required

Unit of the budget.

budgetTypestring required

Type of the budget.

windowstring required

Window of the budget. Use Daily/Weekly/Monthly for creating a time based budget (beta)

applicableOnstring required

Grouping of the budget.

groupBystring required

Grouping Entity of the budget.

actionstring required

Action to be taken if the budget is breached

statusstring

Signifies the state of the budget. (Active/Inactive)

idstring required

Id of the budget.

orgIdstring required

Org Id of the org for the budget.

resetTimestring required

Reset time of the time based scan budget in HH:MM format

resetTimeZonestring required

Time zone of the reset time for the time based scan budget. Follow the format in the IANA Time Zone Database.

resetDayOfWeekstring required

The day of the week when the budget resets, applicable for time based budgets with a Weekly window. Must be a valid day of the week.

resetDateOfMonthinteger required

The date of the month when the budget resets, applicable for time based budgets with a Monthly window. Must be a valid day of the month (1-28).

createdAtstring date-time required

Date & time when budget was created.

createdBystring required

Id of the user who created the budget.

modifiedAtstring date-time required

Date & time when budget was last modified.

modifiedBystring required

Id of the user who last modified the budget.

Example response

{
  "unit": "GB",
  "budgetType": "ScanBudget",
  "scope": {
    "includedUsers": [
      "00000000000001DF",
      "00000000000002D2"
    ],
    "excludedUsers": [
      "00000000000001DF",
      "00000000000002D2"
    ],
    "includedRoles": [
      "00000000000001DF",
      "00000000000002D2"
    ],
    "excludedRoles": [
      "00000000000001DF",
      "00000000000002D2"
    ]
  },
  "window": "Query",
  "applicableOn": "PerEntity",
  "groupBy": "User",
  "action": "Warn",
  "status": "active",
  "resetTime": "23:30",
  "resetTimeZone": "America/Los_Angeles"
}