Broadcom

Broadcom Virtual Machines API

Operations for managing virtual machines

GitHub OpenAPI

Operations 7

GET /vcenter/vm Broadcom List virtual machines #
POST /vcenter/vm Broadcom Create a virtual machine #
GET /vcenter/vm/{vm} Broadcom Get virtual machine details #
DELETE /vcenter/vm/{vm} Broadcom Delete a virtual machine #
GET /vcenter/vm/{vm}/power Broadcom Get VM power state #
POST /vcenter/vm/{vm}/power?action=start Broadcom Power on a virtual machine #
POST /vcenter/vm/{vm}/power?action=stop Broadcom Power off a virtual machine #

Documentation

📖
Documentation
https://developer.broadcom.com/xapis/vsphere-automation-api/latest/
📖
Documentation
https://developer.broadcom.com/xapis/operations-for-applications-rest-api/latest/
📖
Documentation
https://developer.broadcom.com/xapis/sddc-manager-api/latest/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/broadcom/refs/heads/main/openapi/broadcom-virtual-machines-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/broadcom/refs/heads/main/json-schema/broadcom-virtual-machine-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/broadcom/refs/heads/main/json-schema/broadcom-host-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/broadcom/refs/heads/main/json-schema/broadcom-cluster-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/broadcom/refs/heads/main/json-schema/broadcom-dashboard-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/broadcom/refs/heads/main/json-schema/broadcom-alert-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/broadcom/refs/heads/main/json-schema/broadcom-workload-domain-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/broadcom/refs/heads/main/json-schema/broadcom-task-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/broadcom/refs/heads/main/json-ld/broadcom-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/broadcom-virtual-machines-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

broadcom-virtual-machines-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Broadcom vSphere Automation Virtual Machines API
  description: The vSphere Automation API provides a unified programmatic interface for managing VMware vSphere environments. It enables automation of virtual machine lifecycle management, host and cluster configuration, content library management, tagging, and other vSphere infrastructure operations. This RESTful API replaces many legacy SOAP-based interfaces and supports JSON request and response payloads over HTTPS.
  version: 8.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://{vcenter}/api
  description: vCenter Server instance
  variables:
    vcenter:
      default: vcenter.example.com
      description: The hostname or IP address of the vCenter Server
security:
- sessionAuth: []
tags:
- name: Virtual Machines
  description: Operations for managing virtual machines
paths:
  /vcenter/vm:
    get:
      summary: Broadcom List virtual machines
      description: Returns information about all virtual machines matching the specified filters.
      operationId: listVMs
      tags:
      - Virtual Machines
      parameters:
      - name: filter.vms
        in: query
        description: Identifiers of virtual machines to filter
        schema:
          type: array
          items:
            type: string
      - name: filter.names
        in: query
        description: Names of virtual machines to filter
        schema:
          type: array
          items:
            type: string
      - name: filter.power_states
        in: query
        description: Power states to filter
        schema:
          type: array
          items:
            type: string
            enum:
            - POWERED_ON
            - POWERED_OFF
            - SUSPENDED
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VMSummary'
        '401':
          description: Unauthorized
    post:
      summary: Broadcom Create a virtual machine
      description: Creates a virtual machine with the specified configuration.
      operationId: createVM
      tags:
      - Virtual Machines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VMCreateSpec'
      responses:
        '201':
          description: Virtual machine created
          content:
            application/json:
              schema:
                type: string
                description: Identifier of the created VM
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /vcenter/vm/{vm}:
    get:
      summary: Broadcom Get virtual machine details
      description: Returns detailed information about the specified virtual machine.
      operationId: getVM
      tags:
      - Virtual Machines
      parameters:
      - name: vm
        in: path
        required: true
        description: Virtual machine identifier
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMInfo'
        '401':
          description: Unauthorized
        '404':
          description: VM not found
    delete:
      summary: Broadcom Delete a virtual machine
      description: Deletes the specified virtual machine.
      operationId: deleteVM
      tags:
      - Virtual Machines
      parameters:
      - name: vm
        in: path
        required: true
        description: Virtual machine identifier
        schema:
          type: string
      responses:
        '204':
          description: Virtual machine deleted
        '401':
          description: Unauthorized
        '404':
          description: VM not found
  /vcenter/vm/{vm}/power:
    get:
      summary: Broadcom Get VM power state
      description: Returns the power state of the specified virtual machine.
      operationId: getVMPowerState
      tags:
      - Virtual Machines
      parameters:
      - name: vm
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerInfo'
  /vcenter/vm/{vm}/power?action=start:
    post:
      summary: Broadcom Power on a virtual machine
      description: Powers on the specified virtual machine.
      operationId: powerOnVM
      tags:
      - Virtual Machines
      parameters:
      - name: vm
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: VM powered on
        '401':
          description: Unauthorized
        '404':
          description: VM not found
  /vcenter/vm/{vm}/power?action=stop:
    post:
      summary: Broadcom Power off a virtual machine
      description: Powers off the specified virtual machine.
      operationId: powerOffVM
      tags:
      - Virtual Machines
      parameters:
      - name: vm
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: VM powered off
        '401':
          description: Unauthorized
        '404':
          description: VM not found
components:
  schemas:
    PowerInfo:
      type: object
      properties:
        state:
          type: string
          enum:
          - POWERED_ON
          - POWERED_OFF
          - SUSPENDED
    VMInfo:
      type: object
      properties:
        name:
          type: string
        power_state:
          type: string
          enum:
          - POWERED_ON
          - POWERED_OFF
          - SUSPENDED
        cpu:
          type: object
          properties:
            count:
              type: integer
            cores_per_socket:
              type: integer
        memory:
          type: object
          properties:
            size_MiB:
              type: integer
        guest_OS:
          type: string
        hardware:
          type: object
          properties:
            version:
              type: string
    VMSummary:
      type: object
      properties:
        vm:
          type: string
          description: Virtual machine identifier
        name:
          type: string
          description: Virtual machine name
        power_state:
          type: string
          enum:
          - POWERED_ON
          - POWERED_OFF
          - SUSPENDED
        cpu_count:
          type: integer
        memory_size_MiB:
          type: integer
    VMCreateSpec:
      type: object
      required:
      - name
      - guest_OS
      - placement
      properties:
        name:
          type: string
        guest_OS:
          type: string
        placement:
          type: object
          properties:
            folder:
              type: string
            host:
              type: string
            cluster:
              type: string
            datastore:
              type: string
        memory:
          type: object
          properties:
            size_MiB:
              type: integer
        cpu:
          type: object
          properties:
            count:
              type: integer
  securitySchemes:
    sessionAuth:
      type: apiKey
      in: header
      name: vmware-api-session-id
      description: Session token obtained via POST /cis/session
    basicAuth:
      type: http
      scheme: basic
      description: Username and password for session creation
externalDocs:
  description: vSphere Automation API Reference
  url: https://developer.broadcom.com/xapis/vsphere-automation-api/latest/