openapi: 3.1.0
info:
  title: OpenCost Allocation Assets API
  description: The OpenCost API provides real-time and historical reporting of Kubernetes workload costs and underlying cloud infrastructure spend. OpenCost is an open source CNCF specification and reference implementation for Kubernetes cost monitoring and FinOps.
  version: '1.0'
  contact:
    name: OpenCost
    url: https://www.opencost.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://localhost:9003
  description: Local kubectl port-forward to opencost service
tags:
- name: Assets
paths:
  /assets:
    get:
      operationId: getAssets
      summary: Query underlying cloud infrastructure asset costs
      description: Returns the costs of nodes, disks, and load balancers.
      tags:
      - Assets
      parameters:
      - name: window
        in: query
        required: true
        schema:
          type: string
      - name: aggregate
        in: query
        schema:
          type: string
      - name: accumulate
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetsResponse'
components:
  schemas:
    AssetsResponse:
      type: object
      properties:
        code:
          type: integer
        status:
          type: string
        data:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Asset'
    Asset:
      type: object
      properties:
        type:
          type: string
        totalCost:
          type: number
        cpuCost:
          type: number
        ramCost:
          type: number
        providerID:
          type: string
        window:
          type: object
          properties:
            start:
              type: string
              format: date-time
            end:
              type: string
              format: date-time
externalDocs:
  description: OpenCost API Documentation
  url: https://www.opencost.io/docs/integrations/api