Broadcom Proxies API

Proxy management

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

broadcom-proxies-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Broadcom Operations for Applications REST Alerts Proxies 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: Proxies
  description: Proxy management
paths:
  /proxy:
    get:
      summary: Broadcom List proxies
      description: Returns all registered proxies.
      operationId: listProxies
      tags:
      - Proxies
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyList'
  /proxy/{id}:
    get:
      summary: Broadcom Get a proxy
      description: Returns details of the specified proxy.
      operationId: getProxy
      tags:
      - Proxies
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proxy'
    delete:
      summary: Broadcom Delete a proxy
      description: Deletes the specified proxy.
      operationId: deleteProxy
      tags:
      - Proxies
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Proxy deleted
components:
  schemas:
    Proxy:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        hostname:
          type: string
        version:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
        lastCheckInTime:
          type: integer
          format: int64
    ProxyList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Proxy'
  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/