Broadcom

Broadcom Hosts API

ESXi host management

GitHub OpenAPI

Operations 4

GET /hosts Broadcom List hosts #
POST /hosts Broadcom Commission hosts #
GET /hosts/{id} Broadcom Get host details #
GET /vcenter/host Broadcom List hosts #

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-hosts-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-hosts-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-hosts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Broadcom Hosts API
  contact:
    name: Broadcom Developer Support
    url: https://developer.broadcom.com
  license:
    name: Proprietary
    url: https://www.broadcom.com/company/legal/licensing
  version: '1.0'
  description: 'Operations tagged Hosts across 2 of this provider''s published API definitions: broadcom-vmware-cloud-foundation-openapi.yml, broadcom-vsphere-automation-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{sddc-manager}/v1
  description: SDDC Manager instance
  variables:
    sddc-manager:
      default: sddc-manager.example.com
      description: The hostname of the SDDC Manager
- url: https://{vcenter}/api
  description: vCenter Server instance
  variables:
    vcenter:
      default: vcenter.example.com
      description: The hostname or IP address of the vCenter Server
tags:
- name: Hosts
  description: ESXi host management
paths:
  /hosts:
    get:
      summary: Broadcom List hosts
      description: Returns all commissioned hosts.
      operationId: listHosts
      tags:
      - Hosts
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostList'
      security:
      - bearerAuth: []
    post:
      summary: Broadcom Commission hosts
      description: Commissions one or more hosts for use in VCF.
      operationId: commissionHosts
      tags:
      - Hosts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/HostCommissionSpec'
      responses:
        '202':
          description: Host commissioning started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
      security:
      - bearerAuth: []
    servers:
    - url: https://{sddc-manager}/v1
      description: SDDC Manager instance
      variables:
        sddc-manager:
          default: sddc-manager.example.com
          description: The hostname of the SDDC Manager
  /hosts/{id}:
    get:
      summary: Broadcom Get host details
      description: Returns details of the specified host.
      operationId: getHost
      tags:
      - Hosts
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Host'
        '404':
          description: Host not found
      security:
      - bearerAuth: []
    servers:
    - url: https://{sddc-manager}/v1
      description: SDDC Manager instance
      variables:
        sddc-manager:
          default: sddc-manager.example.com
          description: The hostname of the SDDC Manager
  /vcenter/host:
    get:
      summary: Broadcom List hosts
      description: Returns information about hosts in the vCenter Server.
      operationId: listHosts
      tags:
      - Hosts
      parameters:
      - name: filter.names
        in: query
        schema:
          type: array
          items:
            type: string
      - name: filter.connection_states
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - CONNECTED
            - DISCONNECTED
            - NOT_RESPONDING
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HostSummary'
      security:
      - sessionAuth: []
    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
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
    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
    HostList:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/Host'
    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
    HostSummary:
      type: object
      properties:
        host:
          type: string
        name:
          type: string
        connection_state:
          type: string
          enum:
          - CONNECTED
          - DISCONNECTED
          - NOT_RESPONDING
        power_state:
          type: string
          enum:
          - POWERED_ON
          - POWERED_OFF
          - STANDBY
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token obtained via POST /tokens
    basicAuth:
      type: http
      scheme: basic
    sessionAuth:
      type: apiKey
      in: header
      name: vmware-api-session-id
      description: Session token obtained via POST /cis/session
x-refined-from:
- broadcom-vmware-cloud-foundation-openapi.yml
- broadcom-vsphere-automation-openapi.yml