Broadcom Workload Domains API

openapi: 3.1.0
info:
  title: Broadcom Operations for Applications REST Alerts Workload Domains 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: Workload Domains
  description: Workload domain lifecycle management
paths:
  /domains:
    get:
      summary: Broadcom List workload domains
      description: Returns all workload domains.
      operationId: listDomains
      tags:
      - Workload Domains
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainList'
    post:
      summary: Broadcom Create a workload domain
      description: Creates a new workload domain.
      operationId: createDomain
      tags:
      - Workload Domains
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainCreateSpec'
      responses:
        '202':
          description: Domain creation started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
  /domains/{id}:
    get:
      summary: Broadcom Get workload domain details
      description: Returns details of the specified workload domain.
      operationId: getDomain
      tags:
      - Workload Domains
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain'
    delete:
      summary: Broadcom Delete a workload domain
      description: Deletes the specified workload domain.
      operationId: deleteDomain
      tags:
      - Workload Domains
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Domain deletion started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
components:
  schemas:
    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'
    DomainList:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/Domain'
    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
    Domain:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
          - MANAGEMENT
          - VI
        status:
          type: string
        clusters:
          type: array
          items:
            $ref: '#/components/schemas/Cluster'
    DomainCreateSpec:
      type: object
      required:
      - domainName
      - vcenterSpec
      - computeSpec
      properties:
        domainName:
          type: string
        vcenterSpec:
          type: object
        computeSpec:
          type: object
        nsxTSpec:
          type: object
  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/