Edit

Business Central admin center API - Available applications

Get information about the currently available application families, countries/regions, rings, and versions that environments can be created on. The API endpoints here should be utilized to determine what values can be used for environment creation or copying.

Applications and corresponding Countries/regions with Rings

Get a list of the currently available application families, the available countries/regions within those families, and the available rings within the countries/regions.

GET /admin/{apiVersion}/applications/

Route parameters

apiVersion - the version of the Admin Center API. Currently, the latest version is v2.29

Response

{
  "value": [
    {
      "applicationFamily": string, // The name of the family for a given Business Central offered application. (Typically this will just be "BusinessCentral")
      "countriesringDetails": {
          "countryCode": string, // Code for a country/region that the application family supports creating environments within.
          "rings": [{ // A list of logical ring groupings where environments can be created
            "name": string, // The API name of the ring (for example, PROD, PREVIEW)
            "productionRing": bool, // Indicates that the ring is a production ring. Currently there should only be one production ring within a country.
            "friendlyName": string, // The display friendly name of the ring
          }]
      }
    }
  ]
}

Ring details with versions

Gets a list of the currently available versions that an environment can be created on within a logical ring group.

GET /admin/{apiVersion}/applications/{applicationFamily}/Countries/{countryCode}/Rings/{ringName}

Route parameters

apiVersion - the version of the Admin Center API. Currently, the latest version is v2.29

applicationFamily - the family of the ring's application (for example, "BusinessCentral")

countryCode - Code for the ring's country/region.

ringName - the name of the ring to inspect.

Response

{
  "value": [ // A list of the available application versions within the ring that environments can be created on 
    "<version string>",
    "<version string>",
    ...
  ]
}

The Business Central Administration Center API
Manage Apps
Microsoft Dynamics 365 Business Central Server Administration Tool

  • Last updated on