OptScale Resources API

openapi: 3.1.0
info:
  title: OptScale REST Authentication Resources 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: Resources
  description: Cloud resources and assignment rules
paths:
  /cloud_accounts/{cloud_account_id}/cloud_resources:
    get:
      tags:
      - Resources
      summary: List cloud resources for a cloud account
      operationId: listCloudResources
      parameters:
      - $ref: '#/components/parameters/CloudAccountId'
      responses:
        '200':
          description: Resources list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CloudResource'
components:
  parameters:
    CloudAccountId:
      name: cloud_account_id
      in: path
      required: true
      schema:
        type: string
  schemas:
    CloudResource:
      type: object
      properties:
        id:
          type: string
        cloud_resource_id:
          type: string
        resource_type:
          type: string
        region:
          type: string
        cloud_account_id:
          type: string
        active:
          type: boolean
        first_seen:
          type: integer
        last_seen:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: OptScale Documentation
  url: https://hystax.com/documentation/optscale/