Dynamics Community Forum Thread Details

Hi Dynamics and Power Platform Community!

We are working on a phased retirement for the Xrm.OnlineManagementAPI also commonly referred to as the ‘Admin API’. This RESTful API was built many years ago for the CRM product and allowed creation, backup, restore, admin mode, and deletion of CRM instances. This legacy API is documented here. This legacy API and PowerShell module are being replaced by the Power Platform Admin set of modules and APIs.

What if today I call directly the RESTful API at admin.services.crm*.dynamics.com/ ?
We will be disabling this endpoint by the end of October 2020. You will need to transition to using PowerShell going forward. If you have a specific need for REST, please let us know.

What if today I use the XRM.OnlineManagementAPI PowerShell Module?
We will be making one final update to this module to redirect the backend API traffic from the legacy Admin API to the new Power Platform admin center API in October 2020. You may continue to use this module at your own risk, we are updating it for backwards compatibility but will not be making future supportability or hotfix updates going forward. If PowerShell is your tool of choice, we recommend instead converting your processes over to the Power Platform Admin Powershell module.

What’s the major difference between the legacy and new modules? They appear to do the same thing?
The major differentiator is that the new Power Platform admin module is Environment-focused whereas the legacy module was CRM Instance focused. Today for example, you can create environments without a CDS database in the admin center. The new module will allow you to create and manage all environment lifecycle operations (copy, backup, restore, and so forth) for Power Platform instead of just limiting you to CRM Instances.

You’ll see the Important Changes Coming article updated, along with the warning banner across the XRM OnlineManagement API doc pages. Any questions along the way please let us know, and we will be sending email communications to the customers that we see are still using the outdated version in October.