POST /v1/budgets
Create a budget definition
Servers
- https://api.au.sumologic.com/api/
- https://api.ca.sumologic.com/api/
- https://api.de.sumologic.com/api/
- https://api.eu.sumologic.com/api/
- https://api.fed.sumologic.com/api/
- https://api.jp.sumologic.com/api/
- https://api.kr.sumologic.com/api/
- https://api.in.sumologic.com/api/
- https://api.sumologic.com/api/
- https://api.us2.sumologic.com/api/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name of the budget. |
applicableOn |
String | Yes |
Grouping of the budget. |
action |
String | Yes |
Action to be taken if the budget is breached |
groupBy |
String | Yes |
Grouping Entity of the budget. |
capacity |
Integer | Yes |
Capacity of the budget. |
scope |
Object | Yes | |
scope.includedUsers[] |
Array | Yes |
List of userIds included in the budget. |
scope.excludedRoles[] |
Array | Yes |
List of roleIds excluded in the budget. |
scope.includedRoles[] |
Array | Yes |
List of roleIds included in the budget. |
scope.excludedUsers[] |
Array | Yes |
List of userIds excluded in the budget. |
status |
String | No |
Signifies the state of the budget. (Active/Inactive) |
budgetType |
String | Yes |
Type of the budget. |
window |
String | Yes |
Window of the budget. Use Daily/Weekly/Monthly for creating a time based budget (beta) |
unit |
String | Yes |
Unit of the budget. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.