---
title: "Get Cloud Budget"
method: POST
path: "/cloud-budget/{id}/get-item"
tags: ["Cloud Budget"]
---

# Get Cloud Budget

`POST /cloud-budget/{id}/get-item`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/cloud-budget/{id}/get-item`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/cloud-budget/:id/get-item/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve a single Cloud Budget by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` CloudBudgetSelectSchema: Select schema for CloudBudget. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `name` boolean
    - `description` boolean
    - `isEnabled` boolean
    - `cloudAccountId` boolean
    - `monthlyAmount` boolean
    - `currency` boolean
    - `alertThresholds` boolean
    - `alertOnProjection` boolean
    - `alertSeverityId` boolean
    - `onCallDutyPolicies` OnCallDutyPolicyRelationSelectSchema: What a select may name of the OnCallDutyPolicy records a relation holds: set a field to true to include it.
      - `_id` boolean
      - `createdAt` boolean
      - `updatedAt` boolean
      - `deletedAt` boolean
      - `projectId` boolean
      - `name` boolean
      - `repeatPolicyIfNoOneAcknowledgesNoOfTimes` boolean
    - `spentThisMonth` boolean
    - `projectedThisMonth` boolean
    - `lastCheckedAt` boolean
    - `createdByUserId` boolean
    - `deletedByUserId` boolean

## Response `200`

Successful response

- object
  - `data` CloudBudget
    - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of the project this budget belongs to. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation]
    - `name` string, required: What the budget is called. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `description` string: What the budget is for, in your team's words. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `isEnabled` boolean, required: Whether the budget is watched and raises alerts. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `cloudAccountId` string, uuid: ID of the account the budget is for. Empty: every account of the project. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `monthlyAmount` number, required: What the accounts may cost in a calendar month (UTC), in the budget's currency. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `currency` string, required: The currency of the amount, as the clouds bill the accounts: an account billed in another is not counted. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `alertThresholds` string, required: The shares of the budget, in percent, an alert is raised at, comma separated: the first time in a month the spend passes each. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `alertOnProjection` boolean, required: Also alert when the month is on course to pass the budget, at the pace of the last full week: before the money is spent. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `alertSeverityId` string, uuid: ID of the severity of the alerts the budget raises. Empty: the project's least severe. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
    - `onCallDutyPolicies` object[]: The on-call policies the budget's alerts page. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Cloud Resource], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Cloud Resource]
      - `_id` string, uuid: Unique identifier for the entity
    - `spentThisMonth` number: What the accounts cost this month so far, when last checked. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation]
    - `projectedThisMonth` number: What the accounts are on course to cost this month, at the pace of the last full week, when last checked. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation]
    - `lastCheckedAt` object: When the budget was last compared with what the accounts cost. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation]
    - `createdByUserId` string, uuid: ID of the user who created this budget. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation]
    - `deletedByUserId` string, uuid: ID of the user who deleted this budget. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Cloud Resource], Update: [No access - you don't have permission for this operation]

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)