{"title":"Business Central admin center API - manage updates","url":"https://jonas-paprotka.de/docs/dev-itpro/administration/administration-center-api_reschedule_updates/","by":"JOP-AL","license":"Copyright (c) Microsoft Corporation. CC BY 4.0, https://creativecommons.org/licenses/by/4.0/; code samples MIT. From https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/administration-center-api_reschedule_updates, MicrosoftDocs/dynamics365smb-devitpro-pb at 828b6ee (2026-11-19). Changed: includes filled in, links to this site, and for agents shortened without dropping a fact.","credit":"Microsoft Corporation, CC BY 4.0","origin":"https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/administration-center-api_reschedule_updates","source":{"name":"Business Central developer and IT pro docs","repo":"https://github.com/MicrosoftDocs/dynamics365smb-devitpro-pb","commit":"828b6ee72fcd75755627cd6011f3d20899217ab2","date":"2026-11-19"},"checked":"2026-11-19","description":"Learn how to select target versions, reschedule updates, and cancel running updates for Business Central environments using the admin center API.","date":"2026-11-13","meta":{"topic":"reference"},"outline":[{"level":1,"title":"Business Central admin center API - manage updates","slug":"business-central-admin-center-api---manage-updates","at":0,"chars":7444},{"level":2,"title":"Get environment update information","slug":"get-environment-update-information","at":190,"chars":3582},{"level":3,"title":"Route parameters","slug":"route-parameters","at":426,"chars":262},{"level":3,"title":"Response","slug":"response","at":688,"chars":3084},{"level":2,"title":"Select target version for next environment update","slug":"select-target-version-for-next-environment-update","at":3772,"chars":2380},{"level":3,"title":"Route parameters","slug":"route-parameters-1","at":4214,"chars":483},{"level":3,"title":"Body","slug":"body","at":4697,"chars":1276},{"level":3,"title":"Expected error codes","slug":"expected-error-codes","at":5973,"chars":179},{"level":2,"title":"Cancel running update","slug":"cancel-running-update","at":6152,"chars":1076},{"level":3,"title":"Route parameters","slug":"route-parameters-2","at":6572,"chars":437},{"level":3,"title":"Restrictions","slug":"restrictions","at":7009,"chars":219},{"level":2,"title":"Related information","slug":"related-information","at":7228,"chars":216}],"text":"# Business Central admin center API - manage updates\nAllows for the management of scheduled updates such as scheduling the update to run on or after a specific date within a provided range.\n## Get environment update information\nGet information about update target versions and their status for a specific environment.\n```http\nGET /admin/{apiVersion}/applications/{applicationFamily}/environments/{environmentName}/updates\n```\n### Route parameters\napiVersion - the version of the Admin Center API. Currently, the latest version is v2.29\napplicationFamily - the family of the environment's application (for example, \"BusinessCentral\")\nenvironmentName - the name of the targeted environment\n### Response\nReturns information about updates available for the specified environment.\n```json\n{\n  \"value\": [\n    {\n      // Example for a target version that has been released and has been selected as next update for the specified environment\n      \"targetVersion\": \"26.1\",\n      \"available\": true, // Indicates whether the target version has been released\n      \"selected\": true, // Indicates whether the next selected update is for this target version\n      \"scheduleDetails\": {\n        \"updateStatus\": \"scheduled\", // Status of the selected update\n        \"latestSelectableDateTime\": \"YYYY-MM-DDTHH:MM:SSZ\", // Indicates the last date for which the update to this target version can be scheduled\n        \"selectedDateTime\": \"YYYY-MM-DDTHH:MM:SSZ\", // Indicates the datetime for which the update to this target version has been scheduled\n        \"ignoreUpdateWindow\": false, // Indicates whether the update window for the environment may be ignored when running this update\n        \"rolloutStatus\": \"Active\" // Indicates the rollout status of updates to this target version, e.g. \"Active\", \"UnderMaintenance\", or \"Postponed\"\n      },\n      \"targetVersionType\": \"GA\" // Indicates the type of the target version, i.e. \"GA\", \"Preview\" or \"EarlyAccessPreview\"\n    },\n    {\n      // Example for a target version that has been released but has not been selected as next update for the specified environment\n      \"targetVersion\": \"26.2\",\n      \"available\": true,\n      \"selected\": false,\n      \"scheduleDetails\": {\n        \"latestSelectableDateTime\": \"YYYY-MM-DDTHH:MM:SSZ\",\n        \"selectedDateTime\": \"YYYY-MM-DDTHH:MM:SSZ\", // Specifies the date for which this update will be scheduled if Microsoft services select this as next update for the environment, null if no date has been specified by an environment administrator\n        \"ignoreUpdateWindow\": false,\n        \"rolloutStatus\": \"Active\"\n      },\n      \"targetVersionType\": \"GA\" // Indicates the type of the target version, i.e. \"GA\", \"Preview\" or \"EarlyAccessPreview\"\n    },\n    {\n      // Example for a target version that has not yet been released but has been selected as next update for the specified environment\n      \"targetVersion\": \"26.3\",\n      \"available\": false,\n      \"selected\": true,\n      \"expectedAvailability\": {\n        \"month\": 8, // Indicates the number of the month in which the target version is expected to be released\n        \"year\": 2025 // Indicates the year in which the target version is expected to be released\n      },\n      \"targetVersionType\": \"GA\" // Indicates the type of the target version, i.e. \"GA\", \"Preview\" or \"EarlyAccessPreview\"\n    },\n    {\n      // Example for a target version that has not yet been released and has not been selected as next update for the specified environment\n      \"targetVersion\": \"26.4\",\n      \"available\": false,\n      \"selected\": false,\n      \"expectedAvailability\": {\n        \"month\": 9,\n        \"year\": 2025\n      },\n      \"targetVersionType\": \"GA\" // Indicates the type of the target version, i.e. \"GA\", \"Preview\" or \"EarlyAccessPreview\"\n    }\n  ]\n}\n```\n## Select target version for next environment update\nSelect a target version and update date for the next update on an environment. Only one target version can be selected per environment at a time; selecting a new target version for the next environment updates automatically unselects the previous target version.\n```http\nPATCH /admin/{apiVersion}/applications/{applicationFamily}/environments/{environmentName}/updates/{targetVersion}\n```\n### Route parameters\napiVersion - the version of the Admin Center API. Currently, the latest version is v2.29\napplicationFamily - the family of the environment's application (for example, \"BusinessCentral\")\nenvironmentName - the name of the targeted environment\ntargetVersion - Version number of the target version to be selected as next update, must match the value returned by the `GET /admin/vX.XX/applications/{applicationFamily}/environments/{environmentName}/updates` request.\n### Body\nExample for selecting a target version that's available.\n```json\n{\n  \"selected\": true, // Optional. Must be true to select target version; setting this to false returns an error. Omitting it from the body changes scheduleDetails properties for the targetVersion without selecting it or for a targetVersion that is already selected\n  \"targetVersionType\": \"GA\", // Indicates the type of the target version, i.e. \"GA\", \"Preview\" or \"EarlyAccessPreview\". Defaults to \"GA\" if property is omitted from body. \"Preview\" and \"EarlyAccessPreview\" versions can only be scheduled for sandbox environments. Additionally, Partner Sandbox license is required to schedule update targetting \"EarlyAccessPreview\".\n  \"scheduleDetails\": {\n    \"selectedDateTime\": datetime, // Specifies the datetime at which the environment update should start. If selected time is outside the environment update window, the update will start during the next update window\n    \"ignoreUpdateWindow\": boolean // Specifies whether the update window set for the environment might be ignored for this update\n  }\n}\n```\nExample for selecting a target version that isn't yet available.\n```json\n{\n  \"selected\": true // Required. Must be true to select target version. Setting this to false returns an error\n}\n```\n### Expected error codes\napplicationTypeDoesNotExist - the provided value for the application family wasn't found\nenvironmentNotFound - the targeted environment couldn't be found\n## Cancel running update\nCancels a running update or Cloud Migration data upgrade and restores the environment to its state immediately before the operation started. Can only be used while an update is running. The operation might take over an hour during which the environment isn't accessible.\n```http\nPOST /admin/{apiVersion}/applications/{applicationFamily}/environments/{environmentName}/operations/{id}/cancel\n```\n### Route parameters\napiVersion - the version of the Admin Center API. Currently, the latest version is v2.29\napplicationFamily - the family of the environment's application (for example, \"BusinessCentral\")\nenvironmentName - the name of the targeted environment\nid - The operation ID for the update operation. Get it from the `GET /admin/{apiVersion}/applications/{applicationFamily}/environments/{environmentName}/operations` endpoint.\n### Restrictions\n Environment operation must be of type Update or `Data Upgrade`.\n Environment operation must be in state Running.\n For operations of type Update, the environment can't be in the Enforced Update Period.\n## Related information\nThe Business Central Administration Center API<administration-center-api>\ntenant-admin-center-manage-apps\nMicrosoft Dynamics 365 Business Central Server Administration Tool<administration-tool>"}