• What’s new
  • Archive of 2025 What’s New
  • Archive of 2024 What’s New
  • Older What’s New pages
• Getting started
• Creating a Kyndryl Cloud Uplift on Azure account
  • Adding a region to a Kyndryl Cloud Uplift on Azure account
  • Removing a region from a Kyndryl Cloud Uplift on Azure account
• User Guide
• Admin Guide
• Developer tools
  • Getting started with the Kyndryl Cloud Uplift dynamic inventory for Ansible
  • Using containers in Kyndryl Cloud Uplift
  • Using the Kyndryl Cloud Uplift plugin for Jenkins
  • Using PowerShell with Kyndryl Cloud Uplift
  • Getting started with Puppet in Kyndryl Cloud Uplift
  • Using the Terraform provider
    • Getting started with the Terraform provider
    • Terraform provider reference guide
  • Using the Kyndryl Cloud Uplift Automation Pack for IBM UrbanCode Deploy
  • Overview of the Kyndryl Cloud Uplift provider for Vagrant
    • Kyndryl Cloud Uplift provider for Vagrant installation requirements
    • Kyndryl Cloud Uplift provider for Vagrant quick start
    • Modifying Kyndryl Cloud Uplift VMs and environments created by Vagrant
    • Troubleshooting the Kyndryl Cloud Uplift provider for Vagrant and known issues
    • Creating a Vagrantfile
    • Supported Vagrant commands
  • Using the Kyndryl Cloud Uplift automation pack for Visual Studio Team Foundation Server
• REST API
  • API quick start
  • v1 reference
  • v2 reference
  • Example scripts and clients
  • Best practice - Checking for busyness
  • Exporting CSV reports from the API
  • HTTP status codes
  • API troubleshooting
  • Support and terms of use
• Course Manager
• FAQs
  • How do I find the VM user name and password?
  • I can’t sign in to my account. How do I reset my password or find my user name?
  • What connection types work between VMs in the same environment?
  • How does Kyndryl Cloud Uplift generate the VM DNS name?
  • Why can’t I connect to a published service running on a VM?
  • What IP addresses and port ranges does Kyndryl Cloud Uplift use?
  • Can I recover deleted resources?
  • Does Kyndryl Cloud Uplift have regular maintenance windows?
  • Does Kyndryl Cloud Uplift support load balancing?
  • How do I access the BIOS for a VM?
  • How do I access the System Management Services console for an AIX VM?
  • How do I take a snapshot of an environment?
  • How does Kyndryl Cloud Uplift measure storage?
  • Operating systems in Kyndryl Cloud Uplift VMs
  • Kyndryl Cloud Uplift licensed titles FAQ
  • Why does my Windows VM reboot after I add it to an environment?
  • Why is my operation pending?
• Troubleshooting
  • Kyndryl Cloud Uplift error messages
• Glossary

Kyndryl Cloud Uplift REST API

The Kyndryl Cloud Uplift REST API is provided as a Web Services API. The Kyndryl Cloud Uplift API supports automation of a few core use cases, including:

• Creating and editing environments, templates, and their components.
• Starting, suspending, or shutting down virtual machines.
• Providing access to virtual machines through networks and sets of URIs.
• Identifying the status and usage of machines and resources.

For information about how to use the REST API, see the following topics: