Oracle Budget API

The budget API from Oracle — 4 operation(s) for budget.

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-budget-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Use the Budgets API to manage budgets and budget alerts. For more information, see [Budgets Overview](/iaas/Content/Billing/Concepts/budgetsoverview.htm).
  title: Budgets Budget API
  version: '20190111'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/5206052d079d5c8ca6b161abffcdbcb07a30a59e95bc818bd6f4e9f87c304d17.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Budgets API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/5206052d079d5c8ca6b161abffcdbcb07a30a59e95bc818bd6f4e9f87c304d17.yaml
    what: the harvested document for Budgets API
servers:
- url: http://127.0.0.1/20190111
- url: https://127.0.0.1/20190111
tags:
- name: budget
paths:
  /budgets:
    get:
      description: 'Gets a list of budgets in a compartment.


        By default, ListBudgets returns budgets of the ''COMPARTMENT'' target type, and the budget records with only one target compartment OCID.


        To list all budgets, set the targetType query parameter to ALL (for example: ''targetType=ALL'').


        Clients should ignore new targetTypes, or upgrade to the latest version of the client SDK to handle new targetTypes.

        '
      operationId: ListBudgets
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/TargetTypeQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of BudgetSummary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of `Budget`s. If this header appears in the response, then this

                is a partial list of budgets. Include this value as the `page` parameter in a subsequent

                GET request to get the next batch of budgets.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BudgetSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of Budgets
      tags:
      - budget
    post:
      description: 'Creates a new budget.

        '
      operationId: CreateBudget
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The budget was successfully created.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Budget'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new Budget
      tags:
      - budget
      x-example: "POST /20190111/budgets\nHost: usage.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrvur7xq\",\n  \"targetType\" : \"COMPARTMENT\",\n  \"targets\" : [\"ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrvur7xq\"],\n  \"amount\": \"100.00\",\n  \"resetPeriod\": \"Monthly\"\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBudgetDetails'
        description: Details for the new budget.
        required: true
  /budgets/{budgetId}:
    delete:
      description: Deletes a specified budget resource.
      operationId: DeleteBudget
      parameters:
      - $ref: '#/components/parameters/BudgetIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The budget was successfully deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a Budget
      tags:
      - budget
      x-related-resource: '#/definitions/Budget'
    get:
      description: Gets a budget by the identifier.
      operationId: GetBudget
      parameters:
      - $ref: '#/components/parameters/BudgetIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the budget with the given OCID.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Budget'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a Budget
      tags:
      - budget
    put:
      description: Update a budget identified by the OCID.
      operationId: UpdateBudget
      parameters:
      - $ref: '#/components/parameters/BudgetIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The budget was successfully updated.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Budget'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates a Budget
      tags:
      - budget
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBudgetDetails'
        description: The information to be updated.
        required: true
  /budgets/{budgetId}/alertRules:
    get:
      description: 'Returns a list of Alert Rules for a specified budget.

        '
      operationId: ListAlertRules
      parameters:
      - $ref: '#/components/parameters/BudgetIdPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of AlertRuleSummary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of `AlertRuleSummary`. If this header appears in the response, then this

                is a partial list of AlertRuleSummaries. Include this value as the `page` parameter in a subsequent

                GET request to get the next batch of AlertRuleSummaries.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AlertRuleSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all Alert Rules for a Budget
      tags:
      - budget
    post:
      description: 'Creates a new Alert Rule.

        '
      operationId: CreateAlertRule
      parameters:
      - $ref: '#/components/parameters/BudgetIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The Alert Rule was successfully created.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertRule'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new Alert Rule
      tags:
      - budget
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAlertRuleDetails'
        description: Details for the new Alert Rule.
        required: true
  /budgets/{budgetId}/alertRules/{alertRuleId}:
    delete:
      description: Deletes a specified Alert Rule resource.
      operationId: DeleteAlertRule
      parameters:
      - $ref: '#/components/parameters/BudgetIdPathParam'
      - $ref: '#/components/parameters/AlertRuleIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The Alert Rule was successfully deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete an Alert Rule
      tags:
      - budget
      x-related-resource: '#/definitions/AlertRule'
    get:
      description: Gets an Alert Rule for a specified budget.
      operationId: GetAlertRule
      parameters:
      - $ref: '#/components/parameters/BudgetIdPathParam'
      - $ref: '#/components/parameters/AlertRuleIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the Alert Rule with the given OCID.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertRule'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get an Alert Rule for a specified budget
      tags:
      - budget
    put:
      description: Update an Alert Rule for the budget identified by the OCID.
      operationId: UpdateAlertRule
      parameters:
      - $ref: '#/components/parameters/BudgetIdPathParam'
      - $ref: '#/components/parameters/AlertRuleIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The Alert Rule was successfully updated.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If

                you need to contact Oracle about a particular request,

                please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertRule'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates an Alert Rule
      tags:
      - budget
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAlertRuleDetails'
        description: The information to be updated.
        required: true
components:
  parameters:
    PaginationTokenQueryParam:
      description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
      in: query
      name: page
      x-default-description: ''
      schema:
        type: string
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. If not specified, the default is timeCreated.

        The default sort order for timeCreated is DESC.

        The default sort order for displayName is ASC in alphanumeric order.

        '
      in: query
      name: sortBy
      x-obmcs-top-level-enum: '#/definitions/SortBy'
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    TargetTypeQueryParam:
      description: "The type of target to filter by:\n  * ALL - List all budgets\n  * COMPARTMENT - List all budgets with targetType == \"COMPARTMENT\"\n  * TAG - List all budgets with targetType == \"TAG\"\n"
      in: query
      name: targetType
      x-default-description: ''
      schema:
        type: string
        enum:
        - ALL
        - COMPARTMENT
        - TAG
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 25
        maximum: 1000
        minimum: 1
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      x-default-description: ''
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    AlertRuleIdPathParam:
      description: The unique Alert Rule OCID.
      in: path
      name: alertRuleId
      required: true
      x-default-description: ''
      schema:
        type: string
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried, in case of a timeout or

        server error, without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    BudgetIdPathParam:
      description: The unique budget OCID.
      in: path
      name: budgetId
      required: true
      x-default-description: ''
      schema:
        type: string
    DisplayNameQueryParam:
      description: 'A user-friendly name. This does not have to be unique, and it''s changeable.


        Example: `My new resource`

        '
      in: query
      name: displayName
      x-default-description: ''
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    LifecycleStateQueryParam:
      description: The current state of the resource to filter by.
      in: query
      name: lifecycleState
      x-default-description: ''
      x-obmcs-top-level-enum: '#/definitions/LifecycleState'
      schema:
        type: string
        enum:
        - ACTIVE
        - INACTIVE
  schemas:
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    AlertRuleSummary:
      description: The alert rule.
      properties:
        budgetId:
          description: The OCID of the budget.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: The description of the alert rule.
          type: string
        displayName:
          description: The name of the alert rule. Avoid entering confidential information.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The OCID of the alert rule.
          type: string
        lifecycleState:
          description: The current state of the alert rule.
          enum:
          - ACTIVE
          - INACTIVE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        message:
          description: The custom message that will be sent when the alert is triggered.
          type: string
        recipients:
          description: The audience that receives the alert when it triggers.
          type: string
        threshold:
          description: 'The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.

            '
          type: number
          exclusiveMinimum: 0
        thresholdType:
          description: The type of threshold.
          enum:
          - PERCENTAGE
          - ABSOLUTE
          type: string
          x-obmcs-top-level-enum: '#/definitions/ThresholdType'
        timeCreated:
          description: The time when the budget was created.
          format: date-time
          type: string
        timeUpdated:
          description: The time when the budget was updated.
          format: date-time
          type: string
        type:
          description: 'ACTUAL means the alert triggers based on actual usage.

            FORECAST means the alert triggers based on predicted usage.

            '
          enum:
          - ACTUAL
          - FORECAST
          type: string
          x-obmcs-top-level-enum: '#/definitions/AlertType'
        version:
          description: The version of the alert rule. Starts from 1 and increments by 1.
          type: integer
      required:
      - id
      - budgetId
      - displayName
      - type
      - threshold
      - thresholdType
      - recipients
      - timeCreated
      - timeUpdated
      - lifecycleState
    UpdateAlertRuleDetails:
      description: The update alert rule details.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: The description of the alert rule.
          maxLength: 200
          type: string
        displayName:
          description: The name of the alert rule. Avoid entering confidential information.
          maxLength: 200
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        message:
          description: The message to be delivered to the recipients when an alert is triggered.
          maxLength: 1000
          type: string
        recipients:
          description: The audience that receives the alert when it triggers. If you need to clear out this value, pass in an empty string instead of a null value.
          type: string
        threshold:
          description: 'The threshold for triggering the alert, expressed as a whole number or decimal value.

            If the thresholdType is ABSOLUTE, the threshold can have at most 12 digits before the decimal point, and up to two digits after the decimal point.

            If the thresholdType is PERCENTAGE, the maximum value is 10000 and can have up to two digits after the decimal point.

            '
          maximum: 1.0E12
          type: number
          exclusiveMinimum: 0.0
        thresholdType:
          description: The type of threshold.
          enum:
          - PERCENTAGE
          - ABSOLUTE
          type: string
          x-obmcs-top-level-enum: '#/definitions/ThresholdType'
        type:
          description: 'The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or

            FORECAST (the alert triggers based on predicted usage).

            '
          enum:
          - ACTUAL
          - FORECAST
          type: string
          x-obmcs-top-level-enum: '#/definitions/AlertType'
    Budget:
      description: A budget.
      properties:
        actualSpend:
          description: The actual spend in currency for the current budget cycle.
          minimum: 0
          type: number
        alertRuleCount:
          description: The total number of alert rules in the budget.
          minimum: 0
          type: integer
        amount:
          description: 'The amount of the budget expressed in the currency of the customer''s rate card.

            '
          type: number
          exclusiveMinimum: 0
        budgetProcessingPeriodStartOffset:
          default: 1
          description: The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.
          maximum: 31
          minimum: 1
          type: integer
        compartmentId:
          description: The OCID of the compartment.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: The description of the budget.
          type: string
        displayName:
          description: The display name of the budget. Avoid entering confidential information.
          type: string
        endDate:
          description: The time when the one-time budget concludes. For example, `2023-08-12T16:01:19.847222+05:30`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.
          format: date-time
          type: string
        forecastedSpend:
          description: The forecasted spend in currency by the end of the current budget cycle.
          minimum: 0
          type: number
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The OCID of the budget.
          type: string
        lifecycleState:
          description: The current state of the budget.
          enum:
          - ACTIVE
          - INACTIVE
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleState'
        processingPeriodType:
          description: 'The budget processing period type. Valid values are INVOICE, MONTH, and SINGLE_USE.

            '
          enum:
          - INVOICE
          - MONTH
          - SINGLE_USE
          type: string
          x-obmcs-top-level-enum: '#/definitions/ProcessingPeriodType'
        resetPeriod:
          description: 'The reset period for the budget.

            '
  

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-budget-api-openapi.yml