IBM Cloud for VMware Solutions API

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 IBM Cloud® for VMware Solutions, you can quickly and seamlessly integrate or migrate your on-premises VMware® workloads to the IBM Cloud®. This process 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 VMware Solutions documentationhttps://cloud.ibm.com/docs/vmwaresolutions. By using the IBM Cloud for VMware Solutions REST API, you acknowledge that you read and accepted the following third-party agreement: Broadcom termshttps://www.broadcom.com/company/legal/licensing Endpoint URLs The API is available at: text https://api.vmware-solutions.cloud.ibm.com This endpoint is a highly available globally load balanced endpoint. Under normal conditions, API calls to this endpoint are directed to the nearest geographical region from where the endpoint API call is initiated. If the nearest geographical region is not available, the API calls are directed to the next closest regional endpoint. To successfully invoke an API, the endpoint URL must be qualified with a method and authentication credential by using an IAM token in the request header. 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

MethodPathSummary
POST/v1/infra_credentialsSet the IBM Cloud infrastructure account user ID and API key for linked IBM Cloud account
POST/v1/vcenters/nsxtOrder a new VCF for Classic - Automated instance with NSX-T or verify the order
GET/v1/vcenters/{instance_id}Retrieve the detailed information of a VCF for Classic - Automated instance
DELETE/v1/vcenters/{instance_id}Delete a VCF for Classic - Automated instance
PUT/v1/vcenters/{instance_id}/upgrade_licensesUpgrade NSX and vSAN licenses to Enterprise edition for VCF for Classic - Automated
POST/v1/vcenters/{instance_id}/clustersAdd a cluster for a specified VCF for Classic - Automated instance or verify the order
GET/v1/vcenters/{instance_id}/clusters/{cluster_id}Retrieve the detailed information of a cluster
DELETE/v1/vcenters/{instance_id}/clusters/{cluster_id}Delete a cluster
POST/v1/vcenters/{instance_id}/clusters/{cluster_id}/hostsAdd new hosts to a specified cluster
PATCH/v1/vcenters/{instance_id}/clusters/{cluster_id}/hostsDelete hosts from a specified cluster
POST/v1/vcenters/{instance_id}/clusters/{cluster_id}/shared_storagesAdd shared storage to a specified cluster
PATCH/v1/vcenters/{instance_id}/clusters/{cluster_id}/shared_storagesDelete NFS storage from a specified cluster
GET/v2/vcentersList all VCF for Classic - Automated instances as a JSON object
GET/v2/vcenters/{instance_id}/historyList all history messages for a specified VCF for Classic - Automated instance as a JSON object
GET/v2/vcenters/{instance_id}/clustersList all clusters for a specified VCF for Classic - Automated instance as a JSON object
GET/v2/vcenters/{instance_id}/clusters/{cluster_id}/vlansRetrieve the detailed network interface of a cluster as a JSON object
GET/v2/vcenters/{instance_id}/clusters/{cluster_id}/existing_networkRetrieve the existing network of a cluster
GET/v1/vspheresList all VCF for Classic - Flexible instances as a JSON object
POST/v1/vcenters/vssOrder a new VCF for Classic - Flexible instance, verify the order, or get the order price
DELETE/v1/vcenters/vss/{instance_id}Delete a VCF for Classic - Flexible instance
POST/v1/vcenters/vss/{instance_id}/hostsAdd new hosts to a specified VCF for Classic - Flexible instance
PATCH/v1/vcenters/vss/{instance_id}/hostsDelete hosts from a specified VCF for Classic - Flexible instance
GET/v1/vcenters/vss/{instance_id}/current_licensesRetrieve information for all licenses in a VCF for Classic - Flexible instance
GET/v1/vcenters/vss/{instance_id}/allowed_licensesRetrieve information for all licenses that can be ordered separately for a VCF for Classic - Flexible instance
POST/v1/vcenters/vss/{instance_id}/order_licensesOrder a list of licenses that can be ordered separately for a VCF for Classic - Flexible instance
PATCH/v1/vcenters/vss/{instance_id}/order_licensesCancel old licenses and reorder new licenses for a VCF for Classic - Flexible instance
GET/v1/vcenters/vss/{instance_id}/billing_itemsGet all billing item IDs of a VCF for Classic - Flexible instance
PATCH/v1/vcenters/vss/{instance_id}/billing_itemsCancel a list of billing item IDs from a VCF for Classic - Flexible instance
POST/v1/vcenters/{instance_id}/umaDeploy Usage Meter
GET/v2/locationsGet the list of supported data center locations as a JSON object
GET/v2/mzr_locationsGet the list of supported multizone region data center locations as a JSON object
GET/v2/server_typesGet the list of server CPU types that are supported, per location or vSphere version, as a JSON object
GET/v2/shared_storage_tiersGet the list of supported shared storage tiers as a JSON object
GET/v2/existing_networkRetrieve the existing network in a datacenter
GET/v1/service_catalogGet list of available services
GET/v1/service_catalog/{service_id}Retrieve service information
GET/v1/vcenters/{instance_id}/service_instancesList services on instance
POST/v1/vcenters/{instance_id}/service_instancesAdd services or verify order
GET/v1/vcenters/{instance_id}/service_instances/{service_instance_id}Retrieve specified service instance information on an instance
DELETE/v1/vcenters/{instance_id}/service_instances/{service_instance_id}Delete specified service instance on an instance
PATCH/v1/service_instances/{service_instance_id}/service_variablesUpdate or delete variables of service instance
GET/v1/service_instancesList stand-alone services
POST/v1/service_instancesAdd stand-alone services or verify order
PATCH/v1/service_instancesConfigure stand-alone services
GET/v1/service_instances/{service_instance_id}Retrieve information for stand-alone service instance
DELETE/v1/service_instances/{service_instance_id}Delete specified stand-alone service instance