NSX-T Data Center REST API
Associated URIs:
API Description | API Path |
---|---|
Request one-time backupRequest one-time backup. The backup will be uploaded using the same server configuration as for automatic backup. |
POST /policy/api/v1/cluster?action=backup_to_remote
POST /api/v1/cluster?action=backup_to_remote |
Request one-time inventory summary.Request one-time inventory summary. The backup will be uploaded using the same server configuration as for an automatic backup. |
POST /policy/api/v1/cluster?action=summarize_inventory_to_remote
POST /api/v1/cluster?action=summarize_inventory_to_remote |
Get ssh fingerprint of remote(backup) serverGet SHA256 fingerprint of ECDSA key of remote server. The caller should independently verify that the key is trusted. |
POST /policy/api/v1/cluster/backups?action=retrieve_ssh_fingerprint
POST /api/v1/cluster/backups?action=retrieve_ssh_fingerprint |
Get backup configurationGet a configuration of a file server and timers for automated backup. Fields that contain secrets (password, passphrase) are not returned. |
GET /policy/api/v1/cluster/backups/config
GET /api/v1/cluster/backups/config |
Configure backupConfigure file server and timers for automated backup. If secret fields are omitted (password, passphrase) then use the previously set value. |
PUT /policy/api/v1/cluster/backups/config
PUT /api/v1/cluster/backups/config |
Get backup historyGet history of previous backup operations |
GET /policy/api/v1/cluster/backups/history
GET /api/v1/cluster/backups/history |
Get all backup related information for a siteGet a configuration of a file server, timers for automated backup, latest backup status, backups list for a site. Fields that contain secrets (password, passphrase) are not returned. |
GET /policy/api/v1/cluster/backups/overview
GET /api/v1/cluster/backups/overview |
Get backup statusGet status of active backup operations |
GET /policy/api/v1/cluster/backups/status
GET /api/v1/cluster/backups/status |
Initiate a restore operationStart the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. Otherwise, a 409 response is returned. |
POST /policy/api/v1/cluster/restore?action=start
POST /api/v1/cluster/restore?action=start |
Suspend any running restore operationSuspend any currently running restore operation. The restore operation is made up of a number of steps. When this call is issued, any currently running step is allowed to finish (successfully or with errors), and the next step (and therefore the entire restore operation) is suspended until a subsequent resume or cancel call is issued. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING. Otherwise, a 409 response is returned. |
POST /policy/api/v1/cluster/restore?action=suspend
POST /api/v1/cluster/restore?action=suspend |
Advance any suspended restore operationAdvance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is returned. |
POST /policy/api/v1/cluster/restore?action=advance
POST /api/v1/cluster/restore?action=advance |
Cancel any running restore operationThis operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically "/api/v1/cluster/restore/status" API. The response object (ClusterRestoreStatus), contains a field "endpoints". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. |
POST /policy/api/v1/cluster/restore?action=cancel
POST /api/v1/cluster/restore?action=cancel |
Retry any failed restore operationRetry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is returned. |
POST /policy/api/v1/cluster/restore?action=retry
POST /api/v1/cluster/restore?action=retry |
Retry any failed restore operationRetry currently failed restore operation due to incorrect passphrase. User needs to call this api after passphrase is corrected in Backup config. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is returned. Calling this api without passphrase update will result in restore failure due to bad passphrase. |
POST /policy/api/v1/cluster/restore/action/retry_with_updated_config
POST /api/v1/cluster/restore/action/retry_with_updated_config |
List timestamps of all available Cluster Backups.Returns timestamps for all backup files that are available on the SFTP server. |
GET /policy/api/v1/cluster/restore/backuptimestamps
GET /api/v1/cluster/restore/backuptimestamps |
Get Restore configurationGet configuration information for the file server used to store backed-up files. Fields that contain secrets (password, passphrase) are not returned. |
GET /policy/api/v1/cluster/restore/config
(Deprecated)
GET /api/v1/cluster/restore/config (Deprecated) |
Deprecated. Configure Restore SFTP server credentialsConfigure file server where the backed-up files used for the Restore operation are available. |
PUT /policy/api/v1/cluster/restore/config
(Deprecated)
PUT /api/v1/cluster/restore/config (Deprecated) |
List resources for a given instruction, to be shown to/executed by users.For restore operations requiring user input e.g. performing an action, accepting/rejecting an action, etc. the information to be conveyed to users is provided in this call. |
GET /policy/api/v1/cluster/restore/instruction-resources
GET /api/v1/cluster/restore/instruction-resources |
Query Restore Request StatusReturns status information for the specified NSX cluster restore request. |
GET /api/v1/cluster/restore/status
|
Get vCentersGet vCenters registered with overlay adoption migration tool. |
GET /api/v1/migration/overlay-adoption/vcenters
|
Provide vCenter detailsProvide 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 migrationAdd 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 unitsGet assessment units. |
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/assessment/assessment-units/search
|
Get assessment messagesGet 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 vCenterGet 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 mappingGet 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 segmentGet VMs by segment. |
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/inventory/segment/virtual-machines/search
|
Continue workflowContinue workflow. |
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/action/continue
|
Reset workflowReset workflow. |
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/action/reset
|
Rollback workflowRollback 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 feedbacksGet feedbacks. |
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/feedbacks/search
|
Get workflow detailsGet workflow details. |
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/search
|
Get workflow specGet workflow spec. |
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/spec/search
|
Get aggregate info for VMs that belong to VM groupGet 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 listGet DVPG aggregate info list. |
POST /api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflows/dvpg-aggregate-info-list/search
|
Get DVPG migration infoGet 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 pairGet 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 pairGet 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 listGet vCenter workflow timestamp list. |
GET /api/v1/migration/overlay-adoption/workflows/vc-workflow-timestamp-list
|
Get upgrade task statusGet upgrade task status for the given task of the given bundle. Both bundle_name and task_id must be provided, otherwise you will receive a 404 NOT FOUND response. This api is deprecated. Please use API GET /node/upgrade/status-summary to get upgrade status when upgrade is in progress. |
GET /api/v1/cluster/{cluster-node-id}/node/upgrade
(Deprecated)
GET /api/v1/node/upgrade (Deprecated) |
Execute upgrade taskExecute upgrade task. |
POST /api/v1/cluster/{cluster-node-id}/node/upgrade/performtask
POST /api/v1/node/upgrade/performtask |
Get upgrade progress statusGet progress status of last upgrade step, if upgrade bundle is present. |
GET /api/v1/cluster/{cluster-node-id}/node/upgrade/progress-status
GET /api/v1/node/upgrade/progress-status |
Get upgrade status summaryGet status summary of node upgrade, if upgrade bundle is present. |
GET /api/v1/cluster/{cluster-node-id}/node/upgrade/status-summary
GET /api/v1/node/upgrade/status-summary |
Triggers Repository driven Uc UpgradeTriggers repository driven uc upgrade on the node. This API expects that repository is synced across nodes before starting upgrade. |
POST /api/v1/cluster/{cluster-node-id}/node/upgrade/uc
POST /api/v1/node/upgrade/uc |
Upgrade the upgrade coordinator.Upgrade the upgrade coordinator module itself. This call is invoked after user uploads an upgrade bundle. Once this call is invoked, upgrade coordinator stops and gets restarted and target version upgrade coordinator module comes up after restart. |
POST /api/v1/upgrade?action=upgrade_uc
|
Initiate the rollback of the selected component to a previous version.This API enables the rollback of the upgrade coordinator to a previous version. It facilitates downgrading the upgrade coordinator on the other two nodes by utilizing the older version (the 'from' version) of the upgrade coordinator war file stored in the repository. Finally, it performs a self-rollback to the older version on itself. |
POST /api/v1/upgrade?action=rollback
|
Execute pre-upgrade checksRun pre-defined checks to identify potential issues which can be encountered during an upgrade or can cause an upgrade to fail. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of operation is part of upgrade status summary of individual components. Returns HTTP status 500 with error code 30953 if execution of pre-upgrade checks is already in progress. |
POST /api/v1/upgrade?action=execute_pre_upgrade_checks
|
Abort pre-upgrade checksAborts execution of pre-upgrade checks if already in progress. Halts the execution of checks awaiting execution at this point and makes best-effort attempts to stop checks already in execution. Returns without action if execution of pre-upgrade checks is not in progress. |
POST /api/v1/upgrade?action=abort_pre_upgrade_checks
|
Execute post-upgrade checksRun pre-defined checks to identify issues after upgrade of a component. The results of the checks are added to the respective upgrade units aggregate-info. The progress and status of post-upgrade checks is part of aggregate-info of individual upgrade unit groups. Returns HTTP status 500 with error code 30953 if execution of post-upgrade checks is already in progress. |
POST /api/v1/upgrade/{component-type}?action=execute_post_upgrade_checks
|
Lists the supported releases , available on VMware Download site to upgrade current system.The method fetches the available releases from VMware download site to Upgrade from this current system version to any of the available releases. |
GET /api/v1/upgrade/available-releases
|
Get upgrade bannersGet the list of banner message to be show on upgrade UI. |
GET /api/v1/upgrade/banners
|
Upload upgrade bundleUpload the upgrade bundle. The call returns after upload is initiated. User needs to check upload status periodically by retrieving upgrade bundle upload status to find out if the upload is completed. This API is deprecated, please use /upgrade/bundles?action=upload API to upload the upgrade bundle. |
POST /api/v1/upgrade/bundle?action=upload
(Deprecated)
|
Fetch upgrade bundle from given urlFetches the upgrade bundle from url. The call returns after fetch is initiated. Check status by periodically retrieving upgrade bundle upload status using GET /upgrade/bundles/<bundle-id>/upload-status. The upload is complete when the status is SUCCESS. |
POST /api/v1/upgrade/bundles
|
Upload upgrade bundleUpload the upgrade bundle. This call returns after upload is completed. You can check bundle processing status periodically by retrieving upgrade bundle upload status to find out if the upload and processing is completed. |
POST /api/v1/upgrade/bundles?action=upload
|
Get uploaded upgrade bundle informationGet uploaded upgrade bundle information |
GET /api/v1/upgrade/bundles/{bundle-id}
|
Cancel upgrade bundle uploadCancel upload of upgrade bundle. This API works only when bundle upload is in-progress and will not work during post-processing of upgrade bundle. If bundle upload is in-progress, then the API call returns http OK response after cancelling the upload and deleting partially uploaded bundle. |
POST /api/v1/upgrade/bundles/{bundle-id}?action=cancel_upload
|
Get uploaded upgrade bundle statusGet uploaded upgrade bundle status |
GET /api/v1/upgrade/bundles/{bundle-id}/status
|
Get uploaded upgrade bundle upload statusGet uploaded upgrade bundle upload status |
GET /api/v1/upgrade/bundles/{bundle-id}/upload-status
|
Fetches the upgrade consistency report for a component or all components.The method fetches the upgrade consistency report for an individual component or all the components. |
GET /api/v1/upgrade/consistency-report
|
Fetches the upgrade consistency report for a component or all components.The method fetches the upgrade consistency report for an individual component or all the components. |
GET /api/v1/upgrade/consistency-report
|
Accept end user license agreementAccept end user license agreement |
POST /api/v1/upgrade/eula/accept
|
Return the acceptance status of end user license agreementReturn the acceptance status of end user license agreement |
GET /api/v1/upgrade/eula/acceptance
|
Return the content of end user license agreementReturn the content of end user license agreement in the specified format. By default, it's pure string without line break |
GET /api/v1/upgrade/eula/content
|
Return aggregate information of upgrade unit groups filtered using given query.Return information of upgrade unit groups filtered by given query in the upgrade plan. |
POST /api/v1/upgrade/filter/upgrade-unit-groups
|
Return aggregate information of upgrade-units filtered using given query.Return information of upgrade-units filtered by given query in the upgrade plan. |
POST /api/v1/upgrade/filter/upgrade-units
|
Get upgrade unit groups based on the filterGet all the upgrade unit groups based in the filter applied. The filter can be on component type, group name, id,enabled, status, unit name, unit IP. |
GET /api/v1/upgrade/filterGroups
|
Get upgrade unit based on the filterGet all the upgrade unit groups based in the filter applied. The filter can be on component type, group name, id,enabled, status, unit name, unit IP, status, Hypervisor. |
GET /api/v1/upgrade/filterUnits
|
Get functional state of the upgrade coordinatorGet the functional state of the upgrade coordinator. |
GET /api/v1/upgrade/functional-state
|
Get upgrade historyGet upgrade history |
GET /api/v1/upgrade/history
|
Get list of nodes across all typesGet list of nodes. If request parameter component type is specified, then all nodes for that component will be returned. If request parameter component version is specified, then all nodes at that version will be returned. |
GET /api/v1/upgrade/nodes
|
Get summary of nodesGet summary of nodes, which includes node count for each type and component version. |
GET /api/v1/upgrade/nodes-summary
|
Reset upgrade plan to default planReset the upgrade plan to default plan. User has an option to change the default plan. But if after making changes, user wants to go back to the default plan, this is the way to do so. |
POST /api/v1/upgrade/plan?action=reset
|
Start upgradeStart the upgrade. Upgrade will start as per the upgrade plan. |
POST /api/v1/upgrade/plan?action=start
(Deprecated)
|
Pause upgradePause the upgrade. Upgrade will be paused after upgrade of all the nodes currently in progress is completed either successfully or with failure. User can make changes in the upgrade plan when the upgrade is paused. |
POST /api/v1/upgrade/plan?action=pause
|
Execute the upgradeDepending on current upgrade state, start or continue the upgrade. |
POST /api/v1/upgrade/plan?action=upgrade
|
Continue upgradeContinue the upgrade. Resumes the upgrade from the point where it was paused. |
POST /api/v1/upgrade/plan?action=continue
(Deprecated)
|
Stage the upgrade bitsThis will stage the upgrade bits so that upgrade can be driven from outside NSX upgrade-coordinator. If component type is not provided as a request parameter then upgrade staging will be performed on all the components. |
POST /api/v1/upgrade/plan?action=stage-upgrade
|
Upgrade selected unitsUpgrades, Resumes the upgrade of a selected set of units. |
POST /api/v1/upgrade/plan?action=upgrade_selected_units
|
Get upgrade plan settings for the componentGet the upgrade plan settings for the component. |
GET /api/v1/upgrade/plan/{component_type}/settings
|
Update upgrade plan settings for the componentUpdate the upgrade plan settings for the component. |
PUT /api/v1/upgrade/plan/{component_type}/settings
|
Returns pre-upgrade checks in csv formatReturns pre-upgrade checks in csv format |
GET /api/v1/upgrade/pre-upgrade-checks?format=csv
|
Auto resolve the pre upgrade check.Run auto resolve for a pre upgrade check to try and resolve the issue encountered. |
POST /api/v1/upgrade/pre-upgrade-checks/{pre-upgrade-check-id}?action=resolve
|
Acknowledge the pre upgrade check.Some pre-checks can be marked as ACKNOWLEDGE required. Acknowledge status will be saved across pre-upgrade check runs. |
POST /api/v1/upgrade/pre-upgrade-checks/{pre-upgrade-check-id}?action=acknowledge
|
Lists the changeable parameters for enabling or disabling the pre-checksLists the changeable parameters for enabling or disabling the pre-checks. |
GET /api/v1/upgrade/pre-upgrade-checks/edge-failover-readiness/config
|
Updates the config to enable/disable the pre-checksUpdates the config to enable/disable the pre-checks. |
PUT /api/v1/upgrade/pre-upgrade-checks/edge-failover-readiness/config
|
Get Pre-upgrade Check FailuresGet failures resulting from the last execution of pre-upgrade checks. If the execution of checks is in progress, the response has the list of failures observed so far. |
GET /api/v1/upgrade/pre-upgrade-checks/failures
|
Execute checks before entering host into maintenance modeThis API will accept the host identification information(vCenter instance uuid and host moref id). Will execute the host and edge pre-checks that ensure host is ok to enter maintenance mode. The progress and status of upgrade unit returns status OK, if check has passed. Otherwise will return the NOT_OK. if status returns WAIT, In that case system expects client to wait and poll the API after every 1 minute till checks reach terminal state OK or NOT_OK after 8 minutes. |
POST /api/v1/upgrade/pre-upgrade-checks/host/planned-maintenance
|
Get Pre-upgrade Check SuccessGet success resulting from the last execution of pre-upgrade checks. If the execution of checks is in progress, the response has the list of successes observed so far. |
GET /api/v1/upgrade/pre-upgrade-checks/success
|
Get upgrade status summaryGet upgrade status summary |
GET /api/v1/upgrade/status-summary
|
Get upgrade summaryGet upgrade summary |
GET /api/v1/upgrade/summary
|
Get Uc Bundle metadata for last uploaded bundle.Returns the Uc bundle metadata. This information belong the last bundle upload attempt. |
GET /api/v1/upgrade/uc-bundle-metadata
|
Get Uc Upgrade metadata.Returns the Uc upgrade metadata. This information belong the last uc upgrade attempt. |
GET /api/v1/upgrade/uc-upgrade-metadata
|
Get upgrade-coordinator upgrade statusGet upgrade-coordinator upgrade status |
GET /api/v1/upgrade/uc-upgrade-status
|
Get preferences for rendering the UI.Get hints for rendering the UI for the product. This hints are only for UI and are product specific. The keys are contract between UI and backend. They may not be same different products using the upgrade-coordinator core services. The example specified here is for NSX product. |
GET /api/v1/upgrade/ui/preferences
|
Returns information about upgrade checksReturns information of pre-upgrade and post-upgrade checks. If request parameter component type is specified, then returns information about all pre-upgrade and post-upgrade for the component. Otherwise returns information of checks across all component types. |
GET /api/v1/upgrade/upgrade-checks-info
|
Return information of all upgrade unit groupsReturn information of all upgrade unit groups in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty. If request parameter component type is specified, then all upgrade unit groups for that component will be returned. |
GET /api/v1/upgrade/upgrade-unit-groups
|
Create a groupCreate a group of upgrade units. |
POST /api/v1/upgrade/upgrade-unit-groups
|
Get upgrade status for upgrade unit groupsGet upgrade status for upgrade unit groups |
GET /api/v1/upgrade/upgrade-unit-groups-status
|
Delete the upgrade unit groupDelete the specified group. NOTE - A group can be deleted only if it is empty. If user tries to delete a group containing one or more upgrade units, the operation will fail and an error will be returned. |
DELETE /api/v1/upgrade/upgrade-unit-groups/{group-id}
|
Return upgrade unit group informationReturns information about a specific upgrade unit group in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty. |
GET /api/v1/upgrade/upgrade-unit-groups/{group-id}
|
Reorder upgrade unit groupReorder an upgrade unit group by placing it before/after the specified upgrade unit group. |
POST /api/v1/upgrade/upgrade-unit-groups/{group-id}?action=reorder
|
Add upgrade units to specified upgrade unit groupAdd upgrade units to specified upgrade unit group. The upgrade units will be added at the end of the upgrade unit list. |
POST /api/v1/upgrade/upgrade-unit-groups/{group-id}?action=add_upgrade_units
|
Update the upgrade unit groupUpdate the specified upgrade unit group. Removal of upgrade units from the group using this is not allowed. An error will be returned in that case. |
PUT /api/v1/upgrade/upgrade-unit-groups/{group-id}
|
Get upgrade status for groupGet upgrade status for upgrade units in the specified group. User can specify whether to show only the upgrade units with errors. |
GET /api/v1/upgrade/upgrade-unit-groups/{group-id}/status
|
Reorder an upgrade unit within the upgrade unit groupReorder an upgrade unit within the upgrade unit group by placing it before/after the specified upgrade unit |
POST /api/v1/upgrade/upgrade-unit-groups/{group-id}/upgrade-unit/{upgrade-unit-id}?action=reorder
|
Return aggregate information of all upgrade unit groupsReturn information of all upgrade unit groups in the upgrade plan. If request parameter summary is set to true, then only count of upgrade units will be returned, upgrade units list will be empty. If request parameter component type is specified, then all upgrade unit groups for that component will be returned. |
GET /api/v1/upgrade/upgrade-unit-groups/aggregate-info
|
Get upgrade unitsGet upgrade units |
GET /api/v1/upgrade/upgrade-units
|
Get upgrade units statsGet upgrade units stats |
GET /api/v1/upgrade/upgrade-units-stats
|
Get a specific upgrade unitGet a specific upgrade unit |
GET /api/v1/upgrade/upgrade-units/{upgrade-unit-id}
|
Get upgrade units aggregate-infoGet upgrade units aggregate-info |
GET /api/v1/upgrade/upgrade-units/aggregate-info
|
Get the version whitelistGet whitelist of versions for different components |
GET /policy/api/v1/upgrade/version-whitelist
GET /api/v1/upgrade/version-whitelist |
Get the version whitelist for the specified componentGet whitelist of versions for a component. Component can include HOST, EDGE, CCP, MP |
GET /policy/api/v1/upgrade/version-whitelist/{component_type}
GET /api/v1/upgrade/version-whitelist/{component_type} |
Update the version whitelist for the specified component typeUpdate the version whitelist for the specified component type (HOST, EDGE, CCP, MP). |
PUT /policy/api/v1/upgrade/version-whitelist/{component_type}
PUT /api/v1/upgrade/version-whitelist/{component_type} |
Additional
Links