Broadcom

Broadcom Workload Domains API

Workload domain lifecycle management

GitHub OpenAPI

Operations 4

GET /domains Broadcom List workload domains #
POST /domains Broadcom Create a workload domain #
GET /domains/{id} Broadcom Get workload domain details #
DELETE /domains/{id} Broadcom Delete a workload domain #

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-workload-domains-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-workload-domains-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-workload-domains-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Broadcom VMware Cloud Foundation Workload Domains API
  description: The VMware Cloud Foundation API provides RESTful endpoints for managing SDDC (Software-Defined Data Center) infrastructure through the SDDC Manager. It enables automation of host commissioning, cluster management, workload domain lifecycle, network pool configuration, task monitoring, and VCF management component deployments. The API supports both Basic and Bearer token authentication over HTTPS with JSON payloads.
  version: 9.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://{sddc-manager}/v1
  description: SDDC Manager instance
  variables:
    sddc-manager:
      default: sddc-manager.example.com
      description: The hostname of the SDDC Manager
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
    DomainList:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/Domain'
    DomainCreateSpec:
      type: object
      required:
      - domainName
      - vcenterSpec
      - computeSpec
      properties:
        domainName:
          type: string
        vcenterSpec:
          type: object
        computeSpec:
          type: object
        nsxTSpec:
          type: object
    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'
    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'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token obtained via POST /tokens
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: VMware Cloud Foundation API Reference
  url: https://developer.broadcom.com/xapis/sddc-manager-api/latest/