Oracle Usageapi API

The usageapi API from Oracle — 18 operation(s) for usageapi.

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-usageapi-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Use the Usage API to view your Oracle Cloud usage and costs. The API allows you to request data that meets the specified filter criteria, and to group that data by the chosen dimension. The Usage API is used by [Cost Analysis](/Content/Billing/Concepts/costanalysisoverview.htm), [Scheduled Reports](/Content/Billing/Concepts/scheduledreportoverview.htm), and [Carbon Emissions Analysis](/Content/General/Concepts/emissions-management.htm) in the Console. Also see [Using the Usage API](/Content/Billing/Concepts/costanalysisoverview.htm#cost_analysis_using_the_api) for more information.
  title: Usage Usageapi API
  version: '20200107'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/160805cf79c885be02270019926099ebcab17a40de36b74d9f2156bacbda769e.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Usage 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/160805cf79c885be02270019926099ebcab17a40de36b74d9f2156bacbda769e.yaml
    what: the harvested document for Usage API
servers:
- url: http://127.0.0.1/20200107
- url: https://127.0.0.1/20200107
tags:
- name: usageapi
paths:
  /averageCarbonEmissions/{skuPartNumber}:
    get:
      description: 'Returns the average carbon emissions summary by SKU.

        '
      operationId: RequestAverageCarbonEmission
      parameters:
      - $ref: '#/components/parameters/SkuPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: The average carbon emissions summary.
          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/AverageCarbonEmission'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Requests average carbon emissions by SKU.
      tags:
      - usageapi
      x-related-resource: '#/definitions/AverageCarbonEmission'
  /cleanEnergyUsages/{region}:
    get:
      description: 'Returns the clean energy usage summary by region.

        '
      operationId: RequestCleanEnergyUsage
      parameters:
      - $ref: '#/components/parameters/RegionPathParam'
      - $ref: '#/components/parameters/AdQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: The clean energy usage summary.
          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/CleanEnergyUsage'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Requests renewable/clean energy % used by region.
      tags:
      - usageapi
      x-related-resource: '#/definitions/CleanEnergyUsage'
  /configuration:
    get:
      description: 'Returns the configurations list for the UI drop-down list.

        '
      operationId: RequestSummarizedConfigurations
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - description: tenant id
        in: query
        name: tenantId
        required: true
        schema:
          type: string
          maxLength: 255
          minLength: 1
      responses:
        200:
          description: The configuration used for the drop-down list. The value is a list of available items.
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationAggregation'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Returns configurations.
      tags:
      - usageapi
      x-related-resource: '#/definitions/Configuration'
  /customTables:
    get:
      description: 'Returns the saved custom table list.

        '
      operationId: ListCustomTables
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/SavedReportIdQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: The saved custom table list.
          headers:
            opc-next-page:
              description: 'For pagination of a list of custom tables. If this header appears in the response, then this

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

                GET request, to get the next batch of custom tables.

                '
              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/CustomTableCollection'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Returns saved custom tables.
      tags:
      - usageapi
      x-example: 'GET /20200107/customTables?compartmentId=<var>&lt;compartmentId&gt;</var>&savedReportId=<var>&lt;savedReportId&gt;</var>

        Host: usageapi.us-ashburn-1.oci.oraclecloud.com

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/CustomTable'
    post:
      description: 'Returns the created custom table.

        '
      operationId: CreateCustomTable
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: Returns the created custom table ID/name.
          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/CustomTable'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        409:
          $ref: '#/components/responses/409Conflict'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Create a custom table.
      tags:
      - usageapi
      x-example: "POST /20200107/customTables\nHost: usageapi.us-ashburn-1.oci.oraclecloud.com\nauthorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.tenancy.oc1..testid\",\n  \"savedReportId\": \"testReportId\",\n  \"savedCustomTable\": {\n    \"displayName\": \"customTable1\",\n    \"rowGroupBy\": [\n      \"string\"\n    ],\n    \"columnGroupBy\": [\n      \"string\"\n    ],\n    \"groupByTag\": null,\n    \"compartmentDepth\": 1,\n    \"version\": 1\n  }\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomTableDetails'
        description: New custom table details.
        required: true
  /customTables/{customTableId}:
    delete:
      description: 'Delete a saved custom table by the OCID.

        '
      operationId: DeleteCustomTable
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/CustomTableIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: The custom table 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/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        409:
          $ref: '#/components/responses/409Conflict'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a custom table.
      tags:
      - usageapi
      x-example: 'DELETE /20200107/customTables/<var>&lt;customTableId&gt;</var>

        Host: usageapi.us-ashburn-1.oci.oraclecloud.com

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/CustomTable'
    get:
      description: 'Returns the saved custom table.

        '
      operationId: GetCustomTable
      parameters:
      - $ref: '#/components/parameters/CustomTableIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: The saved custom table.
          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/CustomTable'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Returns saved custom table.
      tags:
      - usageapi
      x-example: 'GET /20200107/customTables/<var>&lt;customTableId&gt;</var>

        Host: usageapi.us-ashburn-1.oci.oraclecloud.com

        authorization: <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/CustomTable'
    put:
      description: 'Update a saved custom table by table ID.

        '
      operationId: UpdateCustomTable
      parameters:
      - $ref: '#/components/parameters/CustomTableIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: Returns the updated custom table.
          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/CustomTable'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        409:
          $ref: '#/components/responses/409Conflict'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Update a custom table.
      tags:
      - usageapi
      x-example: "PUT /20200107/customTables/<var>&lt;customTableId&gt;</var>\nHost: usageapi.us-ashburn-1.oci.oraclecloud.com\nauthorization: <var>&lt;authorization and other headers&gt;</var>\n{\n  \"savedCustomTable\": {\n    \"displayName\": \"name1\",\n    \"rowGroupBy\": [\n      \"string\"\n    ],\n    \"columnGroupBy\": [\n      \"string\"\n    ],\n    \"groupByTag\": null,\n    \"compartmentDepth\": 1,\n    \"version\": 1\n  }\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomTableDetails'
        description: The information to be updated.
        required: true
  /queries:
    get:
      description: 'Returns the saved query list.

        '
      operationId: ListQueries
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: The saved queries list.
          headers:
            opc-next-page:
              description: 'For pagination of a list of Queries. If this header appears in the response, then this

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

                GET request, to get the next batch of Queries.

                '
              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/QueryCollection'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Returns saved queries and UI properties.
      tags:
      - usageapi
      x-related-resource: '#/definitions/Query'
    post:
      description: 'Returns the created query.

        '
      operationId: CreateQuery
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: Returns the query ID/name.
          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/Query'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Create a query.
      tags:
      - usageapi
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateQueryDetails'
        description: New query details. Up to ten saved queries.
        required: true
  /queries/{queryId}:
    delete:
      description: 'Delete a saved query by the OCID.

        '
      operationId: DeleteQuery
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/QueryIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: The Query 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/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Delete a query.
      tags:
      - usageapi
      x-related-resource: '#/definitions/Query'
    get:
      description: 'Returns the saved query.

        '
      operationId: GetQuery
      parameters:
      - $ref: '#/components/parameters/QueryIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: The saved query.
          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/Query'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Returns saved query.
      tags:
      - usageapi
      x-related-resource: '#/definitions/Query'
    put:
      description: 'Update a saved query by the OCID.

        '
      operationId: UpdateQuery
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/QueryIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: Returns the updated query.
          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/Query'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Update a query.
      tags:
      - usageapi
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateQueryDetails'
        description: The information to be updated.
        required: true
  /scheduledRuns:
    get:
      description: 'Returns the schedule history list.

        '
      operationId: ListScheduledRuns
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/ScheduleIdQueryParam'
      - $ref: '#/components/parameters/ScheduledRunSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: Returns the schedule past runs list.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/ScheduledRunCollection'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Returns schedule history list.
      tags:
      - usageapi
      x-related-resource: '#/definitions/ScheduledRun'
  /scheduledRuns/{scheduledRunId}:
    get:
      description: 'Returns the saved schedule run.

        '
      operationId: GetScheduledRun
      parameters:
      - $ref: '#/components/parameters/ScheduledRunIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: The saved scheduled run.
          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/ScheduledRun'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Returns saved schedule run.
      tags:
      - usageapi
      x-related-resource: '#/definitions/ScheduledRun'
  /schedules:
    get:
      description: 'Returns the saved schedule list.

        '
      operationId: ListSchedules
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/ScheduleSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/NameQueryParam'
      responses:
        200:
          description: The saved schedule list.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/ScheduleCollection'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Returns the saved schedule list.
      tags:
      - usageapi
      x-related-resource: '#/definitions/Schedule'
    post:
      description: 'Returns the created schedule.

        '
      operationId: CreateSchedule
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: Returns the created scheduled report.
          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/Schedule'
        400:
          $ref: '#/components/responses/400BadRequest'
        401:
          $ref: '#/components/responses/401Unauthorized'
        404:
          $ref: '#/components/responses/404NotAuthorizedOrNotFound'
        409:
          $ref: '#/components/responses/409Conflict'
        412:
          $ref: '#/components/responses/412PreconditionFailed'
        429:
          $ref: '#/components/responses/429TooManyRequests'
        500:
          $ref: '#/components/responses/500InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Create a schedule.
      tags:
      - usageapi
      requestBody:
        content:
          application/json:
            schema:
              $ref

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