openapi: 3.1.0
info:
  title: Turbonomic REST Actions Topology API
  description: The IBM Turbonomic REST API provides programmatic access to the Turbonomic Application Resource Management (ARM) platform. It enables automation of resource optimization actions, querying of entities (VMs, containers, applications, storage), management of markets and policies, retrieval of statistics and analytics, group management, template administration, and topology exploration across hybrid cloud environments.
  version: v3
  contact:
    name: IBM Turbonomic Support
    url: https://www.ibm.com/mysupport/s/topic/0TO0z000000ZnCCGA0/turbonomic-application-resource-management
  license:
    name: IBM Terms of Service
    url: https://www.ibm.com/terms
servers:
- url: https://{turbonomic_host}/api/v3
  description: Turbonomic Server
  variables:
    turbonomic_host:
      description: The hostname or IP address of the Turbonomic server
      default: turbonomic.example.com
tags:
- name: Topology
  description: Explore infrastructure topology and supply chains
paths:
  /topology:
    get:
      operationId: getTopologyDefinitions
      summary: Get Topology Definitions
      description: Retrieve topology definitions describing infrastructure relationships and supply chains.
      tags:
      - Topology
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Topology definitions
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TopologyDefinition'
components:
  schemas:
    TopologyDefinition:
      type: object
      description: A topology definition describing infrastructure relationships
      properties:
        uuid:
          type: string
          description: Unique identifier of the topology definition
        displayName:
          type: string
          description: Human-readable name
        description:
          type: string
          description: Description of this topology definition
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token obtained by calling POST /api/v3/login with username and password. Include in the Authorization header as 'Bearer {token}'.
externalDocs:
  description: Turbonomic REST API Reference
  url: https://www.ibm.com/docs/en/tarm/8.19.3?topic=reference-turbonomic-rest-api-endpoints