extensionUpload resource type

Represents an extension upload in Dynamics 365 Business Central.

Note

Learn about enabling APIs for Business Central in Enabling the APIs for Dynamics 365 Business Central.

Important

The recommended way to upload, install, and manage per-tenant extensions is now the Business Central Admin Center and its API. The in-product Extension Management upload flow and the Automation API extensionUpload endpoint are deprecated and planned for removal in 2027 release wave 1. Learn more in Deprecated features in the platform.

Methods

Method	Return Type	Description
GET extensionUpload	extensionUpload	Gets an extension upload object.
POST extensionUpload	extensionUpload	Creates an extension upload object.
PATCH extensionUpload	extensionUpload	Updates an extension upload object.

Bound Actions

The extensionUpload resource type offers a bound action called upload that uploads the corresponding extensionUpload batch. This action is illustrated in the following example: POST https://<server address>:<server API port>/<server instance name>/api/microsoft/automation/v2.0/companies({id})/extensionUpload({id})/Microsoft.NAV.upload

The response has no content; the response code is 204.

Properties

Property	Type	Description
systemId	GUID	The unique ID of the system.
schedule	string	Specifies the schedule for installation. Values can be "Current version", "Next minor version", or "Next major version".
schemaSyncMode	string	Specifies the schema sync mode for installation. Values can be "Add" or "Force Sync"
extensionContent	stream	The content of the extension.

JSON representation

Here is a JSON representation of the extensionUpload resource.

{
    "systemId": "GUID",
    "schedule": "string",
    "schemaSyncMode": "string",
    "extensionContent": "stream"
}

Related information

GET extensionUpload
POST extensionUpload
PATCH extensionUpload