HCX Workload Migration APIs. Operations Index
All available HCX Workload Migration APIs. Operations
Retrieves a comprehensive list of all HCX interconnect appliances deployed across all service meshes in the HCX environment. This includes appliances at both the local (source) and remote (destination) sites. The API returns complete appliance details including configuration, status, capacity, resource assignments, and health indicators for all deployed appliance types.
Retrieves HCX interconnect appliances matching specified filter criteria. This API provides flexible filtering capabilities to query appliances based on service mesh, endpoint, type, state, and other attributes. Supports including additional data such as certificates in the response for specific appliance types (e.g., Sentinel Gateway certificates).
Update interconnect appliance.
Retrieves traffic statistics and MAC address information for a specific extended network (L2 stretch).
Redeploys an appliance by recreating its VM while preserving configuration. This asynchronous operation creates a new appliance VM, migrates configuration, and removes the old VM. Use this to recover from VM corruption, failed state, or hardware migration scenarios.
Forces immediate synchronization of appliance configuration with HCX Manager database. Resynchronizes settings, refreshes tunnels, and updates certificates. Use when configuration drift is detected or after network/infrastructure changes.
Executes comprehensive diagnostic tests on the appliance. This is an asynchronous operation.
Upgrades the appliance software to a newer version. This is an asynchronous operation.
Retrieves all HCX Interconnect capabilities available in the current deployment. Capabilities define the features and services that can be used based on the deployed infrastructure, licenses, and configuration. Use this to determine which migration types, network services, and features are available.
Get interconnect capabilities for matching specified filters like featureId, category, status and endpointId
Retrieves capabilities available between two specific HCX sites (source and destination)
List all the site-pairs. This API retrieves information about all site pairings configured on the local HCX manager.
Register a remote HCX manager endpoint. This API initiates the site pairing process by authenticating with the remote HCX manager, exchanging certificates, and establishing a trusted connection.
Register a remote HCX manager endpoint. This API initiates the site pairing process by authenticating with the remote HCX manager, exchanging certificates, and establishing a trusted connection.
Un-register a registered remote HCX manager endpoint. This API removes the site pairing and cleans up associated resources.
List compute profiles
This asynchronously creates a new compute profile using the specified configuration and returns a taskId.
The configuration submitted must be unique, non-empty, and include at least one compute resource and a deployment
container with both a valid cluster and datastore. Ensure at least one service, management, and uplink networks are enabled.
Query compute profiles
Provides a preview of firewall rules for a compute profile not yet created. Tomorrow preview may provide other functionality/validations.
Get a compute profile.
Modify a compute profile with config. The behavior is same as create operation.
Delete a compute profile by id.
Provides a preview of firewall rules for an existing compute profile.
Get the list of all the FIPS modules and their versions, certs, etc.
Retrieves comprehensive configuration and operational details for a specific HA group. This API provides complete information about the group's member appliances, current health status, active/standby roles, HA policy configuration, failover history, and performance metrics. Use this endpoint to monitor specific HA group health, troubleshoot issues, or retrieve configuration for automation workflows.
Deletes an HA group and returns member appliances to standalone operation. This operation disables HA protocols, removes group configuration from all member appliances, and restores each appliance to independent operation. Network extensions assigned to the group are redistributed to individual appliances or fail if redistribution is not possible.
Creates a High Availability (HA) group from two or more network extension appliances to provide redundancy and failover capabilities. HA groups ensure continuous network extension service availability if one appliance fails. The group synchronizes state between members, monitors health, and automatically fails over to standby appliances when the primary becomes unavailable.
Retrieves a list of all High Availability groups configured in the HCX environment, optionally filtered by service mesh. Returns summary information for each HA group including member appliances, health status, current active appliance, and HA policy. Use this API to monitor HA group status, verify configurations, or identify groups requiring attention.
get timeline events for HA groups
Redeploys all appliances in an HA group to refresh configuration, apply updates, or recover from configuration drift. This operation undeploys and redeploys each appliance in the group while maintaining HA group integrity and minimizing service disruption. The redeploy is performed sequentially on group members to ensure continuous availability of network extension services.
Attempts to recover an HA group that is in a failed or degraded state by diagnosing issues, resynchronizing configuration, restarting HA services, and repairing member appliances. This operation performs comprehensive recovery actions to restore the HA group to healthy operational state without requiring full redeployment.
Manually triggers immediate failover in an HA group, forcing the active appliance to relinquish its role and promoting a standby appliance to active. This operation is used for planned maintenance, testing failover capability, or emergency situations. Use with caution as it causes brief service disruption during the failover process.
Forces immediate state synchronization across all members of an HA group ensuring all appliances have consistent configuration and state. Use when appliances may be out of sync due to network issues or configuration drift.
Upgrades all appliances in an HA group to the latest available HCX version using a rolling upgrade process to ensure continuous availability. Appliances are upgraded sequentially with automatic failover to minimize service disruption.
Queries and retrieves HCX system alerts based on flexible filter criteria including severity, state, time range, entity, module, and category. This API provides comprehensive access to all system alerts generated by HCX components including appliances, migrations, network extensions, service mesh operations, and system health events. Alerts represent important events, warnings, errors, and informational messages that require administrator attention or provide operational visibility.
Mark an alert as acknowledged. This API updates the alert status to indicate that a user has acknowledged the alert and taken note of it.
This API shall delete an alert, and will not be a part of the query alerts API response subsequently.
Query audit logs from the database based on various filter criteria. This API provides comprehensive audit trail information for all operations performed on the HCX system.
Certificate pertaining to TLS enabled API and appliance management endpoints of HCX
Fetch unused dvpgs and virtual wires from vCenter and NSX. Useful while importing a network.
Miscellaneous settings required to create networks
Miscellaneous settings required to create networks
Deletes the deployment container for the given input id
Fetches the deployment container for the given input id
Updates the deployment container for the given input id
Fetches all deployment containers
Creates the deployment container with the provided input
Imports the network. Based on the input, network can be transit, trunk or internal
Retrieves vCenter compute information including vCenterInstanceUuid. Use this to get the scopeId needed for other compute-related APIs.
Retrieves available deployment containers (clusters, resource pools) for a specific vCenter. Enterprise administrators can view all deployment containers.
Fetch networks for given vcenter
Retrieves a list of all Edge Services Gateways (ESG) accessible to the user.
Creates a new Edge Services Gateway (ESG) for HCX networking. Gateways provide routing, NAT, and firewall services for HCX networks.
Deletes Edge Services Gateway for the given input id
Fetches detailed configuration and status for a specific gateway. Returns complete gateway information including all interfaces, routing configuration, HA settings, and operational status.
Based on the action query parameter action on gateway is performed. Supported actions are upgrade, redeploy, forcesync
Updates Edge Services Gateway for the given input id
Based on the size parameter, Edge Services gateway appliance will change.
Get High Avilability config for gateway
Updates High Avilability config for gateway
Deletes an interface of Edge Services Gateway
Fetches all interfaces of an Edge Services Gateway for the given input id
Updates all interfaces of an Edge Services Gateway for the given input id
Delete interface of an Edge Services Gateway for the given input id and given input index
Fetches interface of an Edge Services Gateway for the given input id and given input index
Updates interface of an Edge Services Gateway for the given input id and given input index
Get permissions for gateway for the logged in user
Retrieves all networks visible to HCX from vCenter inventory. Includes distributed virtual port groups, standard port groups, and NSX segments. Use the optional endpointId parameter to query networks from a remote site.
Creates a network.
Delete Network Profile
Get a Network Profile by ID
Update network
Fetch unused IPs for network
Fetch total IP count for network
Fetch permissions for network
Useful if network is in bad shape.
Fetch used IPs for network
Create API session
Retrieves the current status of an asynchronous job. Most of the HCX operations (gateway creation, migrations, network extensions, etc.) execute asynchronously and return a job ID. Use this endpoint to poll for job completion and retrieve the outcome.
getTechSupportBundles
NDC API to get the JWT token signed with private-key of the certificate
Returns the HCX interconnect appliances metrics details.
Validates network extension configuration before actually extending networks. This API performs comprehensive pre-flight checks to identify potential issues before committing to the extension operation.
Creates Layer 2 network extensions for one or more networks across HCX sites. This is the primary API for extending networks, enabling VMs to maintain their IP addresses and Layer 2 adjacency when migrated between sites. The operation is asynchronous and returns immediately with validation results for each network extension request. Network extensions create secure Layer 2 tunnels using the HCX Network Extension (NE) appliances at both source and destination sites.
Retrieves a comprehensive list of all Layer 2 network extensions managed by this HCX Manager. Returns detailed information about each extended network including configuration, operational status, appliance assignments, feature settings, and health indicators. This API provides visibility into all active network extensions regardless of which site or service mesh they belong to, making it ideal for monitoring and inventory purposes across the entire HCX deployment.
Retrieves detailed configuration and operational status for a specific Layer 2 network extension identified by its extensionId (also known as stretchId). This API provides comprehensive information about a single extended network including all configuration parameters, operational state, health metrics, appliance assignments, and feature settings. Use this endpoint to monitor the status of a specific extension or retrieve its configuration for troubleshooting purposes.
Applies custom VDR (Virtual Distributed Router) MAC addresses to specified network extensions.
Determines which Network Extension (NE) appliances or HA groups are eligible as targets for transitioning existing network extensions. Network extension transition allows moving active Layer 2 extensions from one NE appliance/HA group to another without disrupting the extended network or migrated VMs. This API evaluates appliance compatibility, capacity, and configuration to identify valid transition targets.
Executes network extension transition, moving active Layer 2 extensions from their current Network Extension (NE) appliances or HA groups to new target appliances/groups. This operation migrates the network extension control plane and data plane without disrupting the extended network or affecting VMs using the extension. The transition is performed seamlessly with minimal or zero packet loss depending on the transition scenario.
Create Migrations
Update Migrations
Start Migrations
Query Migrations
Validate Migrations
Delete Migrations
Cancel MIgrations
Retrieves a list of migration waves based on optional filter criteria. This endpoint allows filtering by migration wave ID, state, and source information.
Commits a migration wave by creating mobility groups on the HCX platform. This is an asynchronous operation.
Deletes or un-commits a migration wave based on its current state. This is an asynchronous operation for committed waves.
Conclude the migration wave with the given wave ID.
Get Predictions for given predictionId
Retrieves a paginated list of migration waves with mobility group summaries. This endpoint returns aggregated statistics about mobility groups within each migration wave including VM counts, resource summaries, and state information.
Create new mobility group
Update Mobility Group
This operation will delete specified mobility group, only if all the migrations in the group are in draft state.
Query pre-created mobility groups.
This API will start migrations of all VMs specified in the groups configuration.
This operation will stop all the running migrations specified in mobility groups configuration.
- Request body can be full definition of Mobility Group or simply migrationGroupId(where mobility group is already pre-created).
- Payload can be validated before or after Mobility Group is created.
- Request body will be the Mobility Group Id.
- Prediction will only happen for Mobility Groups that haven't started
This operation will archive specified mobility groups. All migrations in the group must be in terminal state.
Query mobility groups intent.
Create/Update/Delete schedule for a mobility group/migration/s
Fetch transfer and switchover schedule
Fetch mobility group calendar summary
Fetch mobility groups top level summary
Fetch detailed summary for a mobility group
Fetch config of a mobility group
Fetch mobility group migrations summary
Fetch migration details
Perform retry of failed, cancelled migrations of a mobility group.
Create new migration intents
Updates configuration of existing migration intents.
Start migrations with one or more existing intents or use specified intents
Validate migration with existing intents
Gracefully cancels running migrations.
Forcefully terminates a migration that failed to cancel gracefully.
Archives completed, failed, or cancelled migrations (soft delete).
Delete operation will delete one or more archived migrations.
Retry one or more failed and cancelled migration(s).
Fetch calendar summary of migrations belonging to given mobility groups
Fetch Currently confiugred Policy Routes from NSX-T
Configure Policy Routes on NSX-T
Creates a single network extension between source and destination sites.
Enable or Disable MON on the specified network extension
Remove Network Extension
Retrieves a list of all active Layer 2 network extensions.
Creates a Layer 2 extension (network stretch) from source to destination site.
Removes a Layer 2 extension, tearing down the tunnel between sites.
Returns detailed information about virtual machine migrations based on filter criteria. This endpoint queries the migration database and returns comprehensive details including:
Migration configuration (source/destination, type, scheduling)
Real-time progress (transfer/switchover status, bytes transferred, completion percentage)
Network and storage mappings
Placement and resource allocation
Error messages and troubleshooting information
Performs a POST operation on one or more sentinel Resource.
Performs a POST operation on a specific sentinel.
Create sentinel bundle
Get the status of a sentinel bundle task.
Download sentinel bundle.
Uninstalls sentinel software from source system.
Retrieves the status of sentinel uninstall task.
Retrieves the sentinel software version available for upgrade.
Retrieves service meshes that can be used for migrating VMs based on source and destination parameters.
Fetch all compute profiles for given target migration parameters
List all service meshes
Create service mesh
Resync the service mesh with any changes in local or remote compute profiles
Generate diff service mesh.
List all service meshes
Get a service mesh.
Update a service mesh.
Delete a service mesh.
Preview a service mesh.
Run diagnosis on a service mesh.
Get the list of diagnostics runs (summary) of a service mesh matching the filters.
Get the list of diagnostics run of a service mesh.
Returns the HCX site-pair resource containers and their status details.
Get all interconnect tasks
Get a interconnect task by id.
query interconnect tasks.
This API takes an uplinkId as a parameter and returns the last discovered, configured and current MTU values for the uplink
This API takes ServiceMeshId as a parameter, and returns the last discovered, configured and current MTU values for all the uplinks in the service mesh
This API returns the minPI(threshold) values for all migration services.
This API returns the metric data based on the last calculated values for all the uplinks
This API returns the metric data based on the last calculated values for the specified uplinkId and serviceMeshId
This API returns the on demand metric data based on the last calculated values for the service meshes
This API returns the on demand metric data based on the last calculated values for the specified service mesh
Trigger the on demand underlay metrics measurement test for the given service mesh
Trigger the on demand underlay metrics measurement test for the given uplinkId in a specified serviceMeshId
This API returns uplink aggregated metric in ascending order between startTime and endTime, both inclusive (if provided). It is recommended that both startTime and endTime should be passed.
Get an underlay task by id.
Get VMs on extended Network
Toggle VM state between Proximity Routed & Non-Proximity Routed