VMware website screenshot

VMware

Collection of VMware APIs for cloud infrastructure, virtualization, and management solutions including vSphere, NSX, vCloud Director, Tanzu, and Aria operations.

50 APIs 9 Features
Cloud ComputingContainer ManagementHybrid CloudInfrastructureVirtualization

APIs

vSphere API

API for managing VMware vSphere virtualization platform, including VMs, hosts, and datastores.

vSphere Web Services API

Comprehensive SOAP-based API providing access to all vSphere management functionality including virtual machines, hosts, clusters, networking, and storage.

Virtual Infrastructure JSON API

HTTP and JSON based wire protocol as an alternative to SOAP and XML for vCenter Server 8.0 Update 1 and later, documented via OpenAPI 3.0 specification.

vCloud Director API

API for VMware vCloud Director cloud service delivery platform.

NSX-T Data Center API

API for NSX-T network virtualization and security platform.

NSX-T Global Manager API

API for managing NSX Federation with centralized configuration of multiple NSX deployments across sites.

NSX Intelligence API

API for NSX Intelligence and Application Platform providing network traffic data collection, ingestion, and correlation capabilities.

NSX Autonomous Edge API

REST API for NSX Autonomous Edge providing network virtualization capabilities for edge deployments using a resource-oriented architecture with JSON encoding.

vRealize Automation API

API for automating IT service delivery and cloud infrastructure management.

VMware Cloud on AWS API

API for managing VMware Cloud on AWS infrastructure.

Tanzu Kubernetes Grid API

API for managing enterprise-ready Kubernetes clusters.

vRealize Operations API

API for IT operations management and performance monitoring.

Workspace ONE API

API for unified endpoint management and digital workspace platform.

VMware Cloud Foundation API

API for managing the full VMware Cloud Foundation stack including SDDC Manager and Cloud Builder for automated lifecycle management of private cloud infrastructure.

VMware Horizon Server API

API for managing VMware Horizon virtual desktop and application delivery platform including pools, farms, desktops, and sessions.

vSAN Management API

API for managing VMware vSAN software-defined storage including cluster configuration, disk management, health monitoring, and performance analytics.

VMware Aria Operations for Logs API

REST API for VMware Aria Operations for Logs providing programmatic access to log data ingestion, querying, aggregation, and platform configuration.

VMware Aria Operations for Networks API

API for network visibility, analytics, and troubleshooting providing access to application discovery, microsegmentation planning, and network flow analysis.

VMware Aria Suite Lifecycle API

REST API for managing the lifecycle of VMware Aria suite products including deployment, upgrade, patching, and configuration management.

VMware Site Recovery Manager API

REST API gateway for VMware Site Recovery Manager providing programmatic access to disaster recovery operations including protection groups, recovery plans, and replication mana...

VMware Live Cyber Recovery API

REST API for VMware Live Cyber Recovery providing access to cloud file systems, protected sites, VMs, protection groups, and recovery plans for ransomware and disaster recovery.

VMware Live Site Recovery API

API for VMware Live Site Recovery providing disaster recovery as a service capabilities with automated recovery plan execution and testing.

VMware vDefend API

API for VMware vDefend lateral security platform providing network security segmentation, threat detection, network analysis, and malware prevention capabilities.

VCF Operations API

API for VMware Cloud Foundation operations management providing monitoring, analytics, and performance optimization for VCF deployments.

VMware View API

API providing comprehensive access to VMware Horizon View data structures for managing virtual desktop infrastructure including desktop pools, sessions, and entitlements.

VMware Cloud on AWS API Reference

Comprehensive API reference for managing VMware Cloud on AWS infrastructure including SDDCs, organizations, subscriptions, and ESX host configurations.

NSX VMC Policy API

API for managing logical networking in NSX for VMware Cloud on AWS customers including security policies, segments, and gateway configurations.

VMware Cloud Disaster Recovery API

REST API for VMware Cloud Disaster Recovery providing access to cloud file systems, protected sites, protected VMs, protection groups, and Recovery SDDCs.

VMware Aria Automation Orchestrator API

REST API for VMware Aria Automation Orchestrator enabling programmatic access to run and schedule workflows, retrieve workflow details and logs, browse inventories and plug-ins,...

VMware Aria Operations for Networks SaaS API

SaaS version of the VMware Aria Operations for Networks API providing cloud-hosted network visibility, analytics, and microsegmentation planning capabilities with token-based au...

VCF Operations for Networks API

API for VCF Operations for Networks providing network visibility, analytics, and troubleshooting for VMware Cloud Foundation deployments.

VMware Avi Load Balancer API

RESTful API for VMware Avi Load Balancer providing programmatic access to application delivery services including virtual services, pools, service engines, analytics, and health...

VMware Data Services Manager API

API for VMware Data Services Manager providing on-demand provisioning and automated management of PostgreSQL, MySQL, and Microsoft SQL Server databases in vSphere environments.

VMware Data Services Manager Kubernetes API

Kubernetes API for VMware Data Services Manager enabling self-service consumption of supported data services through Kubernetes custom resources.

App Volumes API

API for VMware App Volumes providing programmatic access to real-time application delivery and lifecycle management for virtual desktops and published applications.

VMware vSphere Kubernetes Service API

API for VMware vSphere Kubernetes Service enabling management of Tanzu Kubernetes clusters on vSphere including cluster lifecycle, node pools, and infrastructure configuration.

SDDC Manager API

API for SDDC Manager providing programmatic access to VMware Cloud Foundation workload domain lifecycle management, host commissioning, and infrastructure configuration.

VCF Installer API

API for VMware Cloud Foundation Installer providing automated infrastructure bringup and initial deployment of VCF components.

VCF Operations Orchestrator API

REST API for VMware Cloud Foundation Operations Orchestrator providing workflow automation and orchestration capabilities for VCF infrastructure management.

VMware Cloud Director OpenAPI

Modern RESTful API for VMware Cloud Director defined using OpenAPI standards providing cloud service delivery and multi-tenancy management capabilities.

VMware Cloud Director API

XML-based API for VMware Cloud Director providing comprehensive cloud service provider capabilities including organization, VDC, vApp, and catalog management.

VMware Identity Manager API

API for VMware Identity Manager providing identity and access management capabilities including authentication, authorization, directory integration, and single sign-on.

Operations for Applications REST API

REST API for Operations for Applications providing access to metrics, dashboards, alerts, events, and integrations for full-stack observability and monitoring.

Data Management for VMware Tanzu REST API

REST API for Data Management for VMware Tanzu providing database-as-a-service capabilities for provisioning and managing data services on Kubernetes.

VMware Cloud Foundation for VxRail API

API for managing VMware Cloud Foundation deployments on Dell VxRail hyperconverged infrastructure including cluster expansion, lifecycle management, and VxRail-specific operations.

VCF Usage Meter API

API for VMware Cloud Foundation Usage Meter providing metering and usage reporting capabilities for VMware product consumption tracking by service providers.

Virtual Storage Lifecycle Management API

API for managing the lifecycle of virtual storage including first-class disks, storage policies, and virtual disk operations in vSphere environments.

VMware Private AI Service API

API for VMware Private AI providing on-premises AI and machine learning infrastructure services for deploying and managing AI workloads within VMware environments.

VMware HCX API

REST API for VMware HCX enabling workload mobility, network extension, and disaster recovery across data centers and clouds with support for migration automation and service mes...

VMware Cloud Provider Lifecycle Manager API

API for managing the lifecycle of VMware cloud provider environments including deployment, upgrade, and configuration of VMware products for service providers.

Collections

Pricing Plans

Vmware Plans Pricing

1 plans

PLANS

Rate Limits

Vmware Rate Limits

1 limits

RATE LIMITS

FinOps

Vmware Finops

FINOPS

Features

vSphere Virtualization

Industry-leading server virtualization platform for running and managing virtual machines across data center infrastructure.

NSX Networking

Software-defined networking and security platform with micro-segmentation, load balancing, and distributed firewall.

vSAN Storage

Hyper-converged software-defined storage integrated with vSphere for simplified storage management and high availability.

Tanzu Kubernetes

Enterprise Kubernetes management for building, running, and managing modern containerized applications at scale.

Aria Operations

AI-powered operations management for proactive performance optimization, capacity planning, and intelligent remediation.

Horizon VDI

Virtual desktop and application delivery platform for secure remote work with published desktops and applications.

Cloud Foundation

Integrated software stack for private and hybrid cloud with automated lifecycle management and consistent operations.

Site Recovery

Automated disaster recovery and business continuity with recovery plan orchestration and non-disruptive testing.

Private AI

On-premises AI infrastructure services for deploying and managing AI workloads within VMware environments.

Use Cases

Data Center Modernization

Transform traditional data centers with software-defined compute, storage, and networking for improved agility and efficiency.

Hybrid Cloud Operations

Extend on-premises infrastructure to public clouds with consistent management, security, and networking across environments.

Application Modernization

Containerize existing applications and deploy new cloud-native workloads on Kubernetes with enterprise-grade management.

Disaster Recovery

Protect business-critical workloads with automated failover, recovery plan testing, and ransomware protection.

Virtual Desktop Infrastructure

Deliver secure virtual desktops and applications to remote workers with centralized management and endpoint security.

Network Security

Implement zero-trust security with micro-segmentation, distributed firewall, and threat detection across the network.

Integrations

AWS

VMware Cloud on AWS provides a jointly engineered hybrid cloud service running vSphere on AWS bare-metal infrastructure.

Microsoft Azure

Azure VMware Solution runs VMware workloads natively on Azure with full vSphere, vSAN, and NSX integration.

Google Cloud

Google Cloud VMware Engine provides a fully managed VMware environment on Google Cloud infrastructure.

Dell VxRail

Jointly engineered hyperconverged infrastructure combining VCF with Dell PowerEdge servers for turnkey private cloud.

Kubernetes

Native Kubernetes integration through Tanzu and vSphere with Kubernetes for container orchestration at enterprise scale.

Terraform

Official VMware Terraform provider for infrastructure-as-code automation of vSphere, NSX, and VCF resources.

Semantic Vocabularies

Vmware Context

0 classes · 12 properties

JSON-LD

Vmware Vsphere Context

0 classes · 0 properties

JSON-LD

API Governance Rules

VMware API Rules

7 rules · 7 errors

SPECTRAL

JSON Structure

Vmware Structure

0 properties

JSON STRUCTURE

Vmware Vsphere Cluster Info Structure

2 properties

JSON STRUCTURE

Vmware Vsphere Cluster Summary Structure

4 properties

JSON STRUCTURE

Vmware Vsphere Cpu Info Structure

4 properties

JSON STRUCTURE

Vmware Vsphere Cpu Update Spec Structure

4 properties

JSON STRUCTURE

Vmware Vsphere Datacenter Info Structure

5 properties

JSON STRUCTURE

Vmware Vsphere Datacenter Summary Structure

2 properties

JSON STRUCTURE

Vmware Vsphere Datastore Info Structure

7 properties

JSON STRUCTURE

Vmware Vsphere Datastore Summary Structure

5 properties

JSON STRUCTURE

Vmware Vsphere Disk Create Spec Structure

3 properties

JSON STRUCTURE

Vmware Vsphere Disk Info Structure

4 properties

JSON STRUCTURE

Vmware Vsphere Disk Summary Structure

1 properties

JSON STRUCTURE

Vmware Vsphere Ethernet Create Spec Structure

7 properties

JSON STRUCTURE

Vmware Vsphere Ethernet Info Structure

9 properties

JSON STRUCTURE

Vmware Vsphere Ethernet Summary Structure

1 properties

JSON STRUCTURE

Vmware Vsphere Folder Summary Structure

3 properties

JSON STRUCTURE

Vmware Vsphere Guest Identity Info Structure

5 properties

JSON STRUCTURE

Vmware Vsphere Hardware Info Structure

3 properties

JSON STRUCTURE

Vmware Vsphere Hardware Update Spec Structure

2 properties

JSON STRUCTURE

Vmware Vsphere Host Info Structure

3 properties

JSON STRUCTURE

Vmware Vsphere Host Summary Structure

4 properties

JSON STRUCTURE

Vmware Vsphere Library Create Spec Structure

4 properties

JSON STRUCTURE

Vmware Vsphere Library Info Structure

9 properties

JSON STRUCTURE

Vmware Vsphere Memory Info Structure

4 properties

JSON STRUCTURE

Vmware Vsphere Memory Update Spec Structure

2 properties

JSON STRUCTURE

Vmware Vsphere Network Summary Structure

3 properties

JSON STRUCTURE

Vmware Vsphere Power Info Structure

2 properties

JSON STRUCTURE

Vmware Vsphere Session Info Structure

3 properties

JSON STRUCTURE

Vmware Vsphere Tag Association Spec Structure

2 properties

JSON STRUCTURE

Vmware Vsphere Tag Create Spec Structure

3 properties

JSON STRUCTURE

Vmware Vsphere Vm Create Spec Structure

7 properties

JSON STRUCTURE

Vmware Vsphere Vm Info Structure

11 properties

JSON STRUCTURE

Vmware Vsphere Vm Summary Structure

5 properties

JSON STRUCTURE

Example Payloads

Vmware Attachtag Example

6 fields

EXAMPLE

Vmware Createsession Example

6 fields

EXAMPLE

Vmware Createtag Example

6 fields

EXAMPLE

Vmware Createvm Example

6 fields

EXAMPLE

Vmware Createvmdisk Example

6 fields

EXAMPLE

Vmware Getcluster Example

6 fields

EXAMPLE

Vmware Getdatacenter Example

6 fields

EXAMPLE

Vmware Getdatastore Example

6 fields

EXAMPLE

Vmware Gethost Example

6 fields

EXAMPLE

Vmware Getvm Example

6 fields

EXAMPLE

Vmware Getvmcpu Example

6 fields

EXAMPLE

Vmware Getvmhardware Example

6 fields

EXAMPLE

Vmware Getvmmemory Example

6 fields

EXAMPLE

Vmware Listclusters Example

6 fields

EXAMPLE

Vmware Listfolders Example

6 fields

EXAMPLE

Vmware Listhosts Example

6 fields

EXAMPLE

Vmware Listnetworks Example

6 fields

EXAMPLE

Vmware Listtags Example

6 fields

EXAMPLE

Vmware Listvmdisks Example

6 fields

EXAMPLE

Vmware Listvms Example

6 fields

EXAMPLE

Vmware Updatevmcpu Example

6 fields

EXAMPLE

Vmware Vsphere Vm Info Example

11 fields

EXAMPLE

Visuals

View API subway map

Resources

🔗
LinkedIn
LinkedIn
🌐
Portal
Portal
🔗
Documentation
Documentation
📦
SDKs
SDKs
💻
CodeExamples
CodeExamples
🔗
CLI
CLI
📰
Blog
Blog
💬
Support
Support
👥
GitHubOrganization
GitHubOrganization
👥
GitHubRepository
GitHubRepository
🔗
Login
Login
📜
PrivacyPolicy
PrivacyPolicy
📜
TermsOfService
TermsOfService
🟢
StatusPage
StatusPage
💰
Pricing
Pricing
🔗
JSONLD
JSONLD
🔗
JSONSchema
JSONSchema
🔗
SpectralRules
SpectralRules
🔗
Vocabulary
Vocabulary

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: VMware vSphere Automation REST API
  version: '8.0'
request:
  auth:
    type: apikey
    key: vmware-api-session-id
    value: '{{vmware-api-session-id}}'
    placement: header
items:
- info:
    name: Session
    type: folder
  items:
  - info:
      name: Vmware Get Current Session Information
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/session
    docs: Returns information about the currently authenticated session including the authenticated user.
  - info:
      name: Vmware Create a New Authentication Session
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/session
      auth:
        type: basic
        username: '{{username}}'
        password: '{{password}}'
    docs: Creates a new session by authenticating with vCenter Server credentials. Returns a session identifier that must
      be included in the vmware-api-session-id header for subsequent requests.
  - info:
      name: Vmware Terminate the Current Session
      type: http
    http:
      method: DELETE
      url: https://{vcenter}/api/session
    docs: Terminates the current authenticated session and invalidates the session token.
- info:
    name: VMs
    type: folder
  items:
  - info:
      name: Vmware List Virtual Machines
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/vm
      params:
      - name: filter.vms
        value: ''
        type: query
        description: Identifiers of VMs to filter by
      - name: filter.names
        value: ''
        type: query
        description: Names of VMs to filter by (exact match)
      - name: filter.folders
        value: ''
        type: query
        description: Folders that must contain the VMs
      - name: filter.datacenters
        value: ''
        type: query
        description: Datacenters that must contain the VMs
      - name: filter.hosts
        value: ''
        type: query
        description: Hosts that must contain the VMs
      - name: filter.clusters
        value: ''
        type: query
        description: Clusters that must contain the VMs
      - name: filter.resource_pools
        value: ''
        type: query
        description: Resource pools that must contain the VMs
      - name: filter.power_states
        value: ''
        type: query
        description: Power states to filter by
    docs: Returns a list of virtual machines in the vCenter inventory matching the specified filter criteria. Results can
      be filtered by name, power state, host, cluster, datacenter, folder, and resource pool.
  - info:
      name: Vmware Create a New Virtual Machine
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/vcenter/vm
      body:
        type: json
        data: '{}'
    docs: Creates a new virtual machine with the specified configuration. The VM is created in the powered-off state and must
      be explicitly powered on after creation.
  - info:
      name: Vmware Get Virtual Machine Details
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/vm/:vm
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Returns detailed information about the specified virtual machine including hardware configuration, power state,
      guest OS, and storage information.
  - info:
      name: Vmware Delete a Virtual Machine
      type: http
    http:
      method: DELETE
      url: https://{vcenter}/api/vcenter/vm/:vm
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Permanently deletes the specified virtual machine and all associated virtual disks. The VM must be in a powered-off
      state.
- info:
    name: VM Power
    type: folder
  items:
  - info:
      name: Vmware Get Vm Power State
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/vm/:vm/power
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Returns the current power state of the specified virtual machine.
  - info:
      name: Vmware Power on a Virtual Machine
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/vcenter/vm/:vm/power?action=start
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Powers on the specified virtual machine. The VM must be in a powered-off or suspended state.
  - info:
      name: Vmware Power Off a Virtual Machine
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/vcenter/vm/:vm/power?action=stop
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Powers off the specified virtual machine immediately. This is equivalent to pulling the power cord and does not
      perform a graceful guest OS shutdown. Use the guest shutdown operation for a clean shutdown.
  - info:
      name: Vmware Suspend a Virtual Machine
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/vcenter/vm/:vm/power?action=suspend
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Suspends the specified virtual machine, saving its current state to disk. The VM can be resumed later from the suspended
      state.
  - info:
      name: Vmware Reset a Virtual Machine
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/vcenter/vm/:vm/power?action=reset
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Resets the specified virtual machine. This is equivalent to pressing the reset button and does not perform a graceful
      guest OS reboot.
- info:
    name: VM Hardware
    type: folder
  items:
  - info:
      name: Vmware Get Vm Hardware Configuration
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/vm/:vm/hardware
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Returns the full virtual hardware configuration of the specified virtual machine including CPU, memory, and all
      virtual devices.
  - info:
      name: Vmware Update Vm Hardware Configuration
      type: http
    http:
      method: PATCH
      url: https://{vcenter}/api/vcenter/vm/:vm/hardware
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
      body:
        type: json
        data: '{}'
    docs: Updates the virtual hardware configuration. Some changes require the VM to be powered off.
  - info:
      name: Vmware Get Vm Cpu Configuration
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/vm/:vm/hardware/cpu
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Returns the CPU configuration of the specified virtual machine.
  - info:
      name: Vmware Update Vm Cpu Configuration
      type: http
    http:
      method: PATCH
      url: https://{vcenter}/api/vcenter/vm/:vm/hardware/cpu
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
      body:
        type: json
        data: '{}'
    docs: Updates the CPU configuration. Hot-add of CPUs is supported if the VM and guest OS support it and the VM is powered
      on.
  - info:
      name: Vmware Get Vm Memory Configuration
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/vm/:vm/hardware/memory
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Returns the memory configuration of the specified virtual machine.
  - info:
      name: Vmware Update Vm Memory Configuration
      type: http
    http:
      method: PATCH
      url: https://{vcenter}/api/vcenter/vm/:vm/hardware/memory
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
      body:
        type: json
        data: '{}'
    docs: Updates the memory configuration. Hot-add of memory is supported if the VM and guest OS support it and the VM is
      powered on.
  - info:
      name: Vmware List Vm Virtual Disks
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/vm/:vm/hardware/disk
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Returns a list of virtual disks attached to the specified VM.
  - info:
      name: Vmware Add a Virtual Disk to a Vm
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/vcenter/vm/:vm/hardware/disk
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
      body:
        type: json
        data: '{}'
    docs: Creates and attaches a new virtual disk to the specified VM. Supports creating new VMDK files or attaching existing
      ones.
  - info:
      name: Vmware List Vm Network Adapters
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/vm/:vm/hardware/ethernet
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Returns a list of virtual Ethernet adapters attached to the specified virtual machine.
  - info:
      name: Vmware Add a Network Adapter to a Vm
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/vcenter/vm/:vm/hardware/ethernet
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
      body:
        type: json
        data: '{}'
    docs: Creates and attaches a new virtual Ethernet adapter to the specified virtual machine.
- info:
    name: VM Guest
    type: folder
  items:
  - info:
      name: Vmware Get Guest Os Identity
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/vm/:vm/guest/identity
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Returns guest operating system identity information reported by VMware Tools running inside the VM, including OS
      name, version, hostname, and IP addresses.
  - info:
      name: Vmware Get Guest Networking Information
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/vm/:vm/guest/networking
      params:
      - name: vm
        value: ''
        type: path
        description: Identifier of the virtual machine (e.g., vm-123)
    docs: Returns guest networking information reported by VMware Tools including network interfaces, IP addresses, DNS configuration,
      and routing tables.
- info:
    name: Hosts
    type: folder
  items:
  - info:
      name: Vmware List Esxi Hosts
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/host
      params:
      - name: filter.hosts
        value: ''
        type: query
        description: Identifiers of hosts to filter by
      - name: filter.names
        value: ''
        type: query
        description: Names of hosts to filter by
      - name: filter.folders
        value: ''
        type: query
        description: Folders that must contain the hosts
      - name: filter.datacenters
        value: ''
        type: query
        description: Datacenters that must contain the hosts
      - name: filter.clusters
        value: ''
        type: query
        description: Clusters that must contain the hosts
      - name: filter.connection_states
        value: ''
        type: query
        description: Connection states to filter by
    docs: Returns a list of ESXi hosts in the vCenter inventory matching the specified filter criteria. Results can be filtered
      by name, connection state, cluster, datacenter, and folder.
  - info:
      name: Vmware Get Esxi Host Details
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/host/:host
      params:
      - name: host
        value: ''
        type: path
        description: Identifier of the ESXi host (e.g., host-10)
    docs: Returns detailed information about the specified ESXi host including connection state, hardware, and resource utilization.
  - info:
      name: Vmware Connect an Esxi Host
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/vcenter/host/:host/connect
      params:
      - name: host
        value: ''
        type: path
        description: Identifier of the ESXi host (e.g., host-10)
    docs: Connects to the specified ESXi host, making it available for virtual machine operations.
  - info:
      name: Vmware Disconnect an Esxi Host
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/vcenter/host/:host/disconnect
      params:
      - name: host
        value: ''
        type: path
        description: Identifier of the ESXi host (e.g., host-10)
    docs: Disconnects the specified ESXi host from vCenter Server. Running VMs are not affected but can no longer be managed
      through vCenter.
- info:
    name: Datastores
    type: folder
  items:
  - info:
      name: Vmware List Datastores
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/datastore
      params:
      - name: filter.datastores
        value: ''
        type: query
        description: Identifiers of datastores to filter by
      - name: filter.names
        value: ''
        type: query
        description: Names of datastores to filter by
      - name: filter.types
        value: ''
        type: query
        description: Types of datastores to filter by
      - name: filter.folders
        value: ''
        type: query
        description: Folders that must contain the datastores
      - name: filter.datacenters
        value: ''
        type: query
        description: Datacenters that must contain the datastores
    docs: Returns a list of datastores in the vCenter inventory matching the specified filter criteria. Results can be filtered
      by name, type, datacenter, and folder.
  - info:
      name: Vmware Get Datastore Details
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/datastore/:datastore
      params:
      - name: datastore
        value: ''
        type: path
        description: Identifier of the datastore (e.g., datastore-15)
    docs: Returns detailed information about the specified datastore including capacity, free space, type, and accessible
      hosts.
- info:
    name: Clusters
    type: folder
  items:
  - info:
      name: Vmware List Clusters
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/cluster
      params:
      - name: filter.clusters
        value: ''
        type: query
        description: Identifiers of clusters to filter by
      - name: filter.names
        value: ''
        type: query
        description: Names of clusters to filter by
      - name: filter.folders
        value: ''
        type: query
        description: Folders that must contain the clusters
      - name: filter.datacenters
        value: ''
        type: query
        description: Datacenters that must contain the clusters
    docs: Returns a list of clusters in the vCenter inventory matching the specified filter criteria.
  - info:
      name: Vmware Get Cluster Details
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/cluster/:cluster
      params:
      - name: cluster
        value: ''
        type: path
        description: Identifier of the cluster (e.g., domain-c7)
    docs: Returns detailed information about the specified cluster including DRS and HA configuration.
- info:
    name: Networks
    type: folder
  items:
  - info:
      name: Vmware List Networks
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/network
      params:
      - name: filter.networks
        value: ''
        type: query
        description: Identifiers of networks to filter by
      - name: filter.names
        value: ''
        type: query
        description: Names of networks to filter by
      - name: filter.types
        value: ''
        type: query
        description: Types of networks to filter by
      - name: filter.datacenters
        value: ''
        type: query
        description: Datacenters that must contain the networks
      - name: filter.folders
        value: ''
        type: query
        description: Folders that must contain the networks
    docs: 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.
- info:
    name: Datacenters
    type: folder
  items:
  - info:
      name: Vmware List Datacenters
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/datacenter
      params:
      - name: filter.datacenters
        value: ''
        type: query
        description: Identifiers of datacenters to filter by
      - name: filter.names
        value: ''
        type: query
        description: Names of datacenters to filter by
      - name: filter.folders
        value: ''
        type: query
        description: Folders that must contain the datacenters
    docs: Returns a list of datacenters in the vCenter inventory matching the specified filter criteria.
  - info:
      name: Vmware Create a Datacenter
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/vcenter/datacenter
      body:
        type: json
        data: '{}'
    docs: Creates a new datacenter in the specified folder.
  - info:
      name: Vmware Get Datacenter Details
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/datacenter/:datacenter
      params:
      - name: datacenter
        value: ''
        type: path
        description: Identifier of the datacenter (e.g., datacenter-2)
    docs: Returns detailed information about the specified datacenter.
  - info:
      name: Vmware Delete a Datacenter
      type: http
    http:
      method: DELETE
      url: https://{vcenter}/api/vcenter/datacenter/:datacenter
      params:
      - name: datacenter
        value: ''
        type: path
        description: Identifier of the datacenter (e.g., datacenter-2)
      - name: force
        value: 'true'
        type: query
        description: Force delete even if datacenter is not empty
    docs: Deletes the specified datacenter. All hosts and VMs must be removed from the datacenter before deletion.
- info:
    name: Folders
    type: folder
  items:
  - info:
      name: Vmware List Folders
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/folder
      params:
      - name: filter.folders
        value: ''
        type: query
        description: Identifiers of folders to filter by
      - name: filter.names
        value: ''
        type: query
        description: Names of folders to filter by
      - name: filter.type
        value: DATACENTER
        type: query
        description: Type of folder to filter by
      - name: filter.parent_folders
        value: ''
        type: query
        description: Parent folders to filter by
      - name: filter.datacenters
        value: ''
        type: query
        description: Datacenters that must contain the folders
    docs: Returns a list of folders in the vCenter inventory matching the specified filter criteria.
- info:
    name: Resource Pools
    type: folder
  items:
  - info:
      name: Vmware List Resource Pools
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/resource-pool
      params:
      - name: filter.resource_pools
        value: ''
        type: query
        description: Identifiers of resource pools to filter by
      - name: filter.names
        value: ''
        type: query
        description: Names of resource pools to filter by
      - name: filter.clusters
        value: ''
        type: query
        description: Clusters that must contain the resource pools
      - name: filter.hosts
        value: ''
        type: query
        description: Hosts that must contain the resource pools
      - name: filter.parent_resource_pools
        value: ''
        type: query
        description: Parent resource pools to filter by
    docs: Returns a list of resource pools in the vCenter inventory matching the specified filter criteria.
- info:
    name: Content Library
    type: folder
  items:
  - info:
      name: Vmware List Content Libraries
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/content/library
    docs: Returns a list of all content library identifiers in the vCenter inventory.
  - info:
      name: Vmware Create a Content Library
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/content/library
      body:
        type: json
        data: '{}'
    docs: Creates a new local or subscribed content library for storing templates, ISOs, and OVF packages.
  - info:
      name: Vmware Get Content Library Details
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/content/library/:library_id
      params:
      - name: library_id
        value: '500123'
        type: path
        description: Identifier of the content library
    docs: Returns detailed information about the specified content library.
  - info:
      name: Vmware Delete a Content Library
      type: http
    http:
      method: DELETE
      url: https://{vcenter}/api/content/library/:library_id
      params:
      - name: library_id
        value: '500123'
        type: path
        description: Identifier of the content library
    docs: Deletes the specified content library and all of its items.
- info:
    name: Storage Policies
    type: folder
  items:
  - info:
      name: Vmware List Storage Policies
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/vcenter/storage/policies
      params:
      - name: filter.policies
        value: ''
        type: query
        description: Identifiers of storage policies to filter by
    docs: Returns a list of VM storage policies available in the vCenter inventory.
- info:
    name: Tagging
    type: folder
  items:
  - info:
      name: Vmware List Tag Categories
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/cis/tagging/category
    docs: Returns all tag category identifiers in the system.
  - info:
      name: Vmware Create a Tag Category
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/cis/tagging/category
      body:
        type: json
        data: '{}'
    docs: Creates a new tag category used to group related tags.
  - info:
      name: Vmware List Tags
      type: http
    http:
      method: GET
      url: https://{vcenter}/api/cis/tagging/tag
    docs: Returns all tag identifiers in the system.
  - info:
      name: Vmware Create a Tag
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/cis/tagging/tag
      body:
        type: json
        data: '{}'
    docs: Creates a new tag within a specified category.
  - info:
      name: Vmware Attach a Tag to an Object
      type: http
    http:
      method: POST
      url: https://{vcenter}/api/cis/tagging/tag-association?action=attach
      body:
        type: json
        data: '{}'
    docs: Attaches a tag to a vSphere managed object such as a VM, host, datastore, or cluster.
bundled: true