NSX-T Data Center REST API

Associated URIs:

API Description API Path

Get vCenters


Get vCenters registered with overlay adoption migration tool.
GET /api/v1/migration/overlay-adoption/vcenters

Provide vCenter details


Provide vCenter details to overlay adoption migration tool. The vCenter should already be
registered as a compute manager with NSX.
POST /api/v1/migration/overlay-adoption/vcenters

Add vCenter to scope of migration


Add vCenter to scope of migration. Migration operations can be performed on vCenter only if it is added to
scope of migration. At any given point of time, only one vCenter can be present in the migration scope list,
which means migration operations can be performed only on one vCenter at a time. Invoking this API with a new
valid vCenter ID will remove previous one from the migration scope and add the new one to migration scope. For a
vCenter to be added to scope of migration, it has to satisfy following conditions.
1. vCenter should have been registered as a compute manager with NSX.
2. User should have provided vCenter username and password details via UI or API in the overlay adoption tool.
PUT /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/add_to_migration_scope

Get assessment units


Get assessment units.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/assessment/assessment-units/search

Get assessment messages


Get assessment messages.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/assessment/messages/search

Get VMs by DVPG and VnicIpSubnets.


Get VMs by DVPG and VnicIpSubnets.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/inventory/dvpg/virtual-machines/search

Get DVPGs in vCenter


Get DVPGs of vCenter from the config snapshot collected by overlay adoption migration tool. Since this lists
DVPGs from a snapshot collected earlier, if some DVPGs got added or deleted later, those will not be reflected
in the API response. Migration tool has to collect config again to get the latest vCenter inventory to reflect any
changes that were done after last config collection.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/inventory/dvpgs/search

Get segment to DVPGs mapping


Get information about DVPGs that the segment has been bridged to.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/inventory/segment-to-dvpgs-mapping/search

Get VMs by segment


Get VMs by segment.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/inventory/segment/virtual-machines/search

Continue workflow


Continue workflow.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/action/continue

Reset workflow


Reset workflow.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/action/reset

Rollback workflow


Rollback workflow.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/action/rollback

Start workflow.


Start workflow.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/action/start

Get feedbacks


Get feedbacks.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/feedbacks/search

Get workflow details


Get workflow details.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/search

Get workflow spec


Get workflow spec.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/spec/search

Get aggregate info for VMs that belong to VM group


Get aggregate info list for VMs that belong to VM group
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/vm-group/vm-aggregate-info-list/search

Get DVPG aggregate info list


Get DVPG aggregate info list.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflows/dvpg-aggregate-info-list/search

Get DVPG migration info


Get DVPG migration info. Gives information about all workflows related to the DVPG migration.
GET /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflows/dvpg-migration-info

Get workflows for DVPG and segment pair


Get workflows for DVPG and segment pair.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflows/dvpg-segment-pair/search

Get workflow specs for DVPG and segment pair


Get workflow specs for DVPG and segment pair.
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflows/specs/dvpg-segment-pair/search

Get vCenter workflow timestamp list


Get vCenter workflow timestamp list.
GET /api/v1/migration/overlay-adoption/workflows/vc-workflow-timestamp-list