Broadcom Clusters API

openapi: 3.1.0
info:
  title: Broadcom Operations for Applications REST Alerts Clusters API
  description: The VMware Aria Operations for Applications REST API (formerly Tanzu Observability by Wavefront) enables programmatic interaction with the observability service. It supports querying metrics, managing dashboards, alerts, events, sources, user accounts, API tokens, and ingesting data directly. The API uses JSON payloads over HTTPS and supports both API token and session-based authentication.
  version: 2.0.0
  contact:
    name: Broadcom Developer Support
    url: https://developer.broadcom.com
  license:
    name: Proprietary
    url: https://www.broadcom.com/company/legal/licensing
servers:
- url: https://{instance}.wavefront.com/api/v2
  description: Operations for Applications instance
  variables:
    instance:
      default: example
      description: Your Operations for Applications instance name
security:
- bearerAuth: []
tags:
- name: Clusters
  description: Cluster management
paths:
  /clusters:
    get:
      summary: Broadcom List clusters
      description: Returns all clusters.
      operationId: listClusters
      tags:
      - Clusters
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterList'
  /clusters/{id}:
    get:
      summary: Broadcom Get cluster details
      description: Returns details of the specified cluster.
      operationId: getCluster
      tags:
      - Clusters
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
    patch:
      summary: Broadcom Update a cluster
      description: Updates the specified cluster configuration, such as expanding or shrinking.
      operationId: updateCluster
      tags:
      - Clusters
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterUpdateSpec'
      responses:
        '202':
          description: Cluster update started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
  /vcenter/cluster:
    get:
      summary: Broadcom List clusters
      description: Returns information about clusters in the vCenter Server.
      operationId: listClusters
      tags:
      - Clusters
      parameters:
      - name: filter.names
        in: query
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterSummary'
components:
  schemas:
    ClusterUpdateSpec:
      type: object
      properties:
        hostSpecs:
          type: array
          items:
            $ref: '#/components/schemas/HostCommissionSpec'
        clusterExpansionSpec:
          type: object
    HostCommissionSpec:
      type: object
      required:
      - fqdn
      - username
      - password
      - networkPoolId
      - storageType
      properties:
        fqdn:
          type: string
        username:
          type: string
        password:
          type: string
        networkPoolId:
          type: string
        storageType:
          type: string
          enum:
          - VSAN
          - NFS
          - VMFS_FC
    Host:
      type: object
      properties:
        id:
          type: string
        fqdn:
          type: string
        ipAddress:
          type: string
        status:
          type: string
          enum:
          - ASSIGNED
          - UNASSIGNED
          - DECOMMISSIONED
        domain:
          type: object
          properties:
            id:
              type: string
        cluster:
          type: object
          properties:
            id:
              type: string
    Cluster:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        primaryDatastoreType:
          type: string
        isDefault:
          type: boolean
        isStretched:
          type: boolean
        hosts:
          type: array
          items:
            $ref: '#/components/schemas/Host'
    ClusterSummary:
      type: object
      properties:
        cluster:
          type: string
        name:
          type: string
        ha_enabled:
          type: boolean
        drs_enabled:
          type: boolean
    Task:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESSFUL
          - FAILED
          - CANCELLED
        type:
          type: string
        creationTimestamp:
          type: string
          format: date-time
        completionTimestamp:
          type: string
          format: date-time
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
    ClusterList:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/Cluster'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token for authentication
externalDocs:
  description: Operations for Applications REST API Documentation
  url: https://developer.broadcom.com/xapis/operations-for-applications-rest-api/latest/