Introduction End of Marketing: As of 31 October 2025, new deployments of VMware Solutions offerings are no longer available for new customers. Existing customers can still use and expand their active VMware® workloads on IBM Cloud®. For more information, see End of Marketing for VMware on IBM Cloudhttps://cloud.ibm.com/docs/vmwaresolutions?topic=vmwaresolutions-eos-vms. With the IBM Cloud® for VMware Cloud Foundation as a Service API, you can quickly and seamlessly integrate or migrate your on-premises VMware® workloads to IBM Cloud®. This is done by using the scalable, secure, and high-performance IBM Cloud infrastructure and the industry-leading VMware hybrid virtualization technology. You can easily deploy your VMware virtual environments and manage the infrastructure resources on IBM Cloud. At the same time, you can still use your familiar native VMware product console to manage the VMware workloads. For more information, see the VCF as a Service documentationhttps://cloud.ibm.com/docs/vmware-service. By using the IBM Cloud for VMware Cloud Foundation as a Service REST API, you acknowledge that you have read and accepted the following third-party agreements: Broadcom termshttps://www.broadcom.com/company/legal/licensing Microsoft termshttps://cloud.ibm.com/vmware/static/terms/3rdPartySoftwareTermsMicrosoftVMWaaS.pdf Red Hat termshttps://cloud.ibm.com/vmware/static/terms/3rdPartySoftwareTermsRedHatIC4V.pdf Endpoint URLs The API is available at: text https://api.{region}.vmware.cloud.ibm.com/v1 Not all regions support VCF as a Service. For more information, see IBM Cloud data center availabilityhttps://cloud.ibm.com/docs/vmware-service?topic=vmware-service-tenant-plan-deploytenant-plan-deploy-locations. To successfully invoke an API, the endpoint URL must be qualified with a method and authentication credential through an IAM token in the request header. For VMware licenseshttps://cloud.ibm.com/apidocs/vmware-servicelist-licenses and Usage Meter registrationshttps://cloud.ibm.com/apidocs/vmware-servicelist-usage-meter-registrations, the APIs are available at https://licensing.vmware.cloud.ibm.com/v1 Authentication Authentication to the API is managed by IBM Cloud Identity and Access Management IAM. To work with the API, you must add an IBM Cloud IAM access token in the API request authentication header: text -H 'Authorization: Bearer Method Path Summary POST /director_sites Create a Cloud Director site instance GET /director_sites List Cloud Director site instances GET /director_sites/{id} Get a Cloud Director site instance DELETE /director_sites/{id} Delete a Cloud Director site instance POST /director_sites/{site_id}/action/enable_veeam Enable or disable Veeam on a Cloud Director site POST /director_sites/{site_id}/action/enable_vcda Enable or disable VCDA on a Cloud Director site POST /director_sites/{site_id}/vcda/connection_endpoints Create a VCDA connection DELETE /director_sites/{site_id}/services/vcda/connection_endpoints/{id} Delete a VCDA connection PATCH /director_sites/{site_id}/services/vcda/connection_endpoints/{id} Update VCDA connection allowlist POST /director_sites/{site_id}/services/vcda/c2c_connections Create a VCDA cloud-to-cloud connection DELETE /director_sites/{site_id}/services/vcda/c2c_connections/{id} Delete a VCDA cloud-to-cloud connection PATCH /director_sites/{site_id}/services/vcda/c2c_connections/{id} Update note in the cloud-to-cloud connection GET /director_sites/{site_id}/oidc_configuration Get an OIDC configuration PUT /director_sites/{site_id}/oidc_configuration Set an OIDC configuration GET /director_sites/{site_id}/pvdcs List the resource pools in a Cloud Director site instance POST /director_sites/{site_id}/pvdcs Create a resource pool instance in a specified Cloud Director site GET /director_sites/{site_id}/pvdcs/{id} Get the specified resource pool in a Cloud Director site instance GET /director_sites/{site_id}/pvdcs/{pvdc_id}/clusters List clusters POST /director_sites/{site_id}/pvdcs/{pvdc_id}/clusters Create a cluster GET /director_sites/{site_id}/pvdcs/{pvdc_id}/clusters/{id} Get a cluster DELETE /director_sites/{site_id}/pvdcs/{pvdc_id}/clusters/{id} Delete a cluster PATCH /director_sites/{site_id}/pvdcs/{pvdc_id}/clusters/{id} Update a cluster GET /director_site_regions List regions GET /multitenant_director_sites Get all multitenant Cloud Director sites GET /director_site_host_profiles List host profiles GET /vdcs List virtual data centers POST /vdcs Create a virtual data center GET /vdcs/{id} Get a virtual data center DELETE /vdcs/{id} Delete a virtual data center PATCH /vdcs/{id} Update a virtual data center PUT /vdcs/{vdc_id}/edges/{edge_id}/transit_gateways/{id} Add IBM Transit Gateway connections to edge DELETE /vdcs/{vdc_id}/edges/{edge_id}/transit_gateways/{id} Remove IBM Transit Gateway connections from edge PATCH /vdcs/{vdc_id}/edges/{edge_id}/swap_primary_and_secondary_network_locations Swap primary and secondary locations for network regional HA edges GET /licenses List VMware licenses GET /usage_meter_registrations List Usage Meter registrations POST /usage_meter_registrations Create a Usage Meter registration GET /usage_meter_registrations/{id} Get a Usage Meter registration DELETE /usage_meter_registrations/{id} Delete a Usage Meter registration GET /vcfs/regions List all regions supported by VCF on VPC GET /vcfs/hostprofiles List VPC host-profiles supported for VCF on VPC GET /vcfs/pricing List VCF on VPC pricing metrics per region POST /vcfs/vsan/calculatestorage Calculate estimated usable vSAN storage based on local host storage GET /vcfs List all instances of VCF on VPC POST /vcfs Order a new VCF on VPC Server instance GET /vcfs/{vcf_id} Get the details of a VCF instance DELETE /vcfs/{vcf_id} Delete VCF on VPC instance with the given id PUT /vcfs/{vcf_id} Reset vcf error status POST /vcfs/{vcf_id}/domain/{domain_id}/host Add one or more hosts to a VCF on VPC instance PATCH /vcfs/{vcf_id}/domain/{domain_id}/host Remove one or more hosts from a VCF on VPC instance PATCH /vcfs/{vcf_id}/sddcmgr/ibm_admin/password Change password for sddc manager: ibm_admin PATCH /vcfs/{vcf_id}/nsxmgr/ibm_admin/password Change password for nsx manager: ibm_admin POST /vcfs/name Verify if the VCFon VPC name exists under same cloud account and region GET /vcfs/hostnames Retrieve List of hostnames for VPC hosts used in VCF on VPC. POST /vcfs/hostnames Verifies if the list of hostnames are unique and valid