openapi: 3.2.0
info:
  description: Use the Usage Proxy API to list Oracle Support Rewards, view related detailed usage information, and manage users who redeem rewards. For more information, see [Oracle Support Rewards Overview](/iaas/Content/Billing/Concepts/supportrewardsoverview.htm).
  title: Usage Proxy Resources API
  version: '20190111'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/923c4c9e7faf08854042f276c1ca058bf5c0d7901ddbf9c52717a1816a0e8d82.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Usage Proxy 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/923c4c9e7faf08854042f276c1ca058bf5c0d7901ddbf9c52717a1816a0e8d82.yaml
    what: the harvested document for Usage Proxy API
servers:
- url: https://127.0.0.1/20190111
tags:
- name: resources
paths:
  /resources:
    get:
      description: 'Returns the resource details for a service.

        > **Important**: Calls to this API will only succeed against the endpoint in the home region.

        '
      operationId: ListResources
      parameters:
      - $ref: '#/components/parameters/ServiceNameQueryParam'
      - $ref: '#/components/parameters/ResourceCompartmentIdQueryParam'
      - $ref: '#/components/parameters/EntitlementIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenParam'
      - $ref: '#/components/parameters/PaginationLimitParam'
      - $ref: '#/components/parameters/SortOrderParam'
      - $ref: '#/components/parameters/SortByParam'
      responses:
        200:
          description: The resources of a service.
          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/ResourcesCollection'
        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:
          description: Unexpected error.
          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/Error'
      summary: Returns the resource details of a service
      tags:
      - resources
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/ResourceSummary'
  /resources/quota:
    get:
      description: 'Returns the resource quota details in a tenancy.

        > **Important**: Calls to this API will only succeed against the endpoint in the home region.

        '
      operationId: ListResourceQuota
      parameters:
      - $ref: '#/components/parameters/ServiceNameQueryParam'
      - $ref: '#/components/parameters/ResourceCompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ServiceEntitlementIdQueryParam'
      - $ref: '#/components/parameters/PaginationTokenParam'
      - $ref: '#/components/parameters/PaginationLimitParam'
      - $ref: '#/components/parameters/SortOrderParam'
      - $ref: '#/components/parameters/SortByParam'
      responses:
        200:
          description: The resources of a service.
          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/ResourceQuotumCollection'
        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:
          description: Unexpected error.
          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/Error'
      summary: Returns the resource quota details under a tenancy
      tags:
      - resources
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/ResourceQuotumSummary'
components:
  parameters:
    ServiceNameQueryParam:
      description: Service name.
      in: query
      name: serviceName
      required: true
      schema:
        type: string
    SortOrderParam:
      description: The sort order to use, which can be ascending (ASC) or descending (DESC).
      in: query
      name: sortOrder
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: DESC
    PaginationTokenParam:
      description: The value of the 'opc-next-page' response header from the previous call.
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 512
        minLength: 1
    SortByParam:
      description: The field to sort by. Supports one sort order.
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - TIMECREATED
        - TIMESTART
        default: TIMECREATED
    ServiceEntitlementIdQueryParam:
      description: Service entitlement ID.
      in: query
      name: serviceEntitlement
      required: false
      x-default-description: 'null'
      schema:
        type: string
    EntitlementIdQueryParam:
      description: Subscription or entitlement ID.
      in: query
      name: entitlementId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    RequestIdHeader:
      description: Unique, Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
      in: header
      name: opc-request-id
      schema:
        type: string
    ResourceCompartmentIdQueryParam:
      description: The OCID of the root compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationLimitParam:
      description: The maximum number of items to return in the paginated response.
      in: query
      name: limit
      schema:
        type: integer
        default: 50
        maximum: 1000
        minimum: 1
  schemas:
    ResourcesCollection:
      description: The resources of a service.
      properties:
        items:
          description: The list of resource details for a service.
          items:
            $ref: '#/components/schemas/ResourceSummary'
          maxItems: 2000
          minItems: 0
          type: array
      required:
      - items
    ResourceQuotumSummary:
      description: 'The resource quota balance details.

        '
      properties:
        affectedResource:
          description: The affected resource name.
          type: string
        balance:
          description: The quota balance.
          example: 0
          format: double
          type: number
        isAllowed:
          default: true
          description: Indicates if further quota consumption is allowed.
          type: boolean
        isDependency:
          description: Indicates any resource dependencies.
          type: boolean
        isOverage:
          description: Indicates if overages have been incurred.
          type: boolean
        limit:
          description: The quota limit.
          example: 5
          format: double
          type: number
        name:
          description: The resource name.
          type: string
        purchasedLimit:
          description: The purchased quota limit.
          example: 5
          format: double
          type: number
        service:
          description: The service name.
          example: Compute
          type: string
      type: object
    Error:
      description: Error object model.
      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
      type: object
    ResourceQuotumCollection:
      description: The quota details of resources in a tenancy.
      properties:
        isAllowed:
          default: true
          description: Indicates if further quota consumption is allowed.
          type: boolean
        items:
          description: The list of resource quota details.
          items:
            $ref: '#/components/schemas/ResourceQuotumSummary'
          maxItems: 1000
          minItems: 0
          type: array
      required:
      - items
      - isAllowed
    SkuProducts:
      description: 'The SKU product ID details for a resource.

        '
      properties:
        cloudCreditType:
          description: The cloud credit type for the resource.
          example: CLOUDCM
          type: string
        skuId:
          description: The SKU ID for the resource.
          example: B88269
          type: string
        skuType:
          description: The SKU type for the resource.
          example: COMMITMENT
          type: string
      type: object
    ResourceSummary:
      description: 'The details of a resource under a service.

        '
      properties:
        childResources:
          description: The details of any child resources.
          example: '[ OCPU_GP, OCPU_HP ]'
          items:
            type: string
          type: array
        dailyUnitDisplayName:
          description: Units to be used for daily aggregated data.
          example: OCPU Hours
          type: string
        description:
          description: Description of the resource.
          example: 'Oracle Cloud Infrastructure - Compute Classic - Compute Capacity - OCPU Per Hour '
          type: string
        hourlyUnitDisplayName:
          description: Units to be used for hourly aggregated data.
          example: OCPU Hours
          type: string
        instanceType:
          description: Instance type for the resource.
          type: string
        isPurchased:
          default: false
          description: Indicates if the SKU was purchased.
          type: boolean
        name:
          description: Name of the resource.
          example: OCPU
          type: string
        rawUnitDisplayName:
          description: Default units to use when unspecified.
          example: number
          type: string
        servicename:
          description: Name of the service.
          example: Compute
          type: string
        skus:
          description: The details of resource SKUs.
          items:
            $ref: '#/components/schemas/SkuProducts'
          type: array
        usageDataType:
          description: Usage data type of the resource.
          enum:
          - INTERVAL
          - POINT_DATA
          type: string
      type: object
x-anchors:
  x-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.

        '
      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.

        '
      type: string
x-oracle-package: com.oracle.pic.usage