Broadcom Tasks API

Asynchronous task monitoring

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

broadcom-tasks-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Broadcom Operations for Applications REST Alerts Tasks 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: Tasks
  description: Asynchronous task monitoring
paths:
  /tasks:
    get:
      summary: Broadcom List tasks
      description: Returns all tasks.
      operationId: listTasks
      tags:
      - Tasks
      parameters:
      - name: status
        in: query
        schema:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESSFUL
          - FAILED
          - CANCELLED
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskList'
  /tasks/{id}:
    get:
      summary: Broadcom Get task details
      description: Returns details of the specified task.
      operationId: getTask
      tags:
      - Tasks
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
components:
  schemas:
    TaskList:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/Task'
    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
  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/