openapi: 3.1.0
info:
  title: OptScale REST Authentication Expenses API
  description: OptScale is an open-source FinOps and cloud cost optimization platform by Hystax. The REST API exposes endpoints for managing organizations, cloud accounts, employees, pools, resources, expenses, recommendations, and optimization runs across AWS, Azure, GCP, Alibaba Cloud, and Kubernetes.
  version: '2.0'
  contact:
    name: Hystax OptScale
    url: https://hystax.com/optscale/
    email: info@hystax.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://{host}/restapi/v2
  description: OptScale REST API server
  variables:
    host:
      default: my.optscale.com
      description: OptScale hostname
security:
- bearerAuth: []
tags:
- name: Expenses
  description: Cost reporting and expense breakdowns
paths:
  /organizations/{organization_id}/expenses:
    get:
      tags:
      - Expenses
      summary: Query expenses
      operationId: getExpenses
      parameters:
      - $ref: '#/components/parameters/OrganizationId'
      - name: start_date
        in: query
        schema:
          type: integer
          description: Unix timestamp
      - name: end_date
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: Expenses summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpensesSummary'
components:
  schemas:
    ExpensesSummary:
      type: object
      properties:
        total:
          type: number
        previous_total:
          type: number
        breakdown:
          type: object
          additionalProperties:
            type: number
  parameters:
    OrganizationId:
      name: organization_id
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: OptScale Documentation
  url: https://hystax.com/documentation/optscale/