VMware Networks API

openapi: 3.1.0
info:
  title: VMware vSphere Automation REST Clusters Networks API
  description: RESTful API for managing VMware vSphere virtualization platform resources including virtual machines, hosts, datastores, clusters, networks, and related infrastructure. The vSphere Automation API provides modern REST endpoints for vCenter Server operations using JSON payloads and session-based or OAuth authentication. This API supersedes the legacy SOAP-based vSphere Web Services API for most automation use cases.
  version: '8.0'
  contact:
    name: Broadcom Developer Support
    url: https://developer.broadcom.com/
  license:
    name: Proprietary
    url: https://www.broadcom.com/company/legal/terms-of-use
  termsOfService: https://www.broadcom.com/company/legal/terms-of-use
servers:
- url: https://{vcenter}/api
  description: vCenter Server REST API endpoint
  variables:
    vcenter:
      default: vcenter.example.com
      description: Hostname or IP address of your vCenter Server instance
security:
- sessionAuth: []
- basicAuth: []
tags:
- name: Networks
  description: Virtual network management including standard and distributed port groups and network connectivity
paths:
  /vcenter/network:
    get:
      operationId: listNetworks
      summary: Vmware List Networks
      description: Returns a list of networks in the vCenter inventory matching the specified filter criteria, including standard port groups, distributed port groups, and NSX logical switches.
      tags:
      - Networks
      parameters:
      - name: filter.networks
        in: query
        description: Identifiers of networks to filter by
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
        example: []
      - name: filter.names
        in: query
        description: Names of networks to filter by
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
        example: []
      - name: filter.types
        in: query
        description: Types of networks to filter by
        schema:
          type: array
          items:
            type: string
            enum:
            - STANDARD_PORTGROUP
            - DISTRIBUTED_PORTGROUP
            - OPAQUE_NETWORK
        style: form
        explode: true
        example: []
      - name: filter.datacenters
        in: query
        description: Datacenters that must contain the networks
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
        example: []
      - name: filter.folders
        in: query
        description: Folders that must contain the networks
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
        example: []
      responses:
        '200':
          description: List of networks matching the filter
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NetworkSummary'
              examples:
                Listnetworks200Example:
                  summary: Default listNetworks 200 response
                  x-microcks-default: true
                  value:
                  - network: example_value
                    name: Example Title
                    type: STANDARD_PORTGROUP
        '400':
          description: Invalid filter parameters
        '401':
          description: Not authenticated
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    NetworkSummary:
      type: object
      description: Summary of a network in the vCenter inventory
      required:
      - network
      - name
      properties:
        network:
          type: string
          description: Unique identifier of the network
          example: example_value
        name:
          type: string
          description: Display name of the network
          example: Example Title
        type:
          type: string
          description: Type of the network
          enum:
          - STANDARD_PORTGROUP
          - DISTRIBUTED_PORTGROUP
          - OPAQUE_NETWORK
          example: STANDARD_PORTGROUP
  securitySchemes:
    sessionAuth:
      type: apiKey
      in: header
      name: vmware-api-session-id
      description: Session token obtained from POST /session. Include this header in all subsequent API requests.
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using vCenter Server credentials. Used primarily for creating sessions.
externalDocs:
  description: vSphere Automation API Reference on Broadcom Developer Portal
  url: https://developer.broadcom.com/xapis/vsphere-automation-api/latest/