Microsoft Dynamics NAV Configuration Packages API

Manage RapidStart configuration packages

Documentation GitHub OpenAPI

Operations 5

GET /companies({company_id})/configurationPackages List Configuration Packages #

POST /companies({company_id})/configurationPackages Create a Configuration Package #

PATCH /companies({company_id})/configurationPackages({package_id})/file('{code}')/content Upload Rapidstart Package File #

POST /companies({company_id})/configurationPackages({package_id})/Microsoft.NAV.import Import a Configuration Package #

POST /companies({company_id})/configurationPackages({package_id})/Microsoft.NAV.apply Apply a Configuration Package #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/navision-configuration-packages-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Business Central Automation API v2.0 Configuration Packages API
  description: API for automating company setup and tenant management in Dynamics 365 Business Central. Supports creating companies, installing and managing extensions, assigning permission sets to users, uploading and applying RapidStart packages, managing user groups and security groups, and activating features programmatically.
  version: '2.0'
  contact:
    name: Microsoft Dynamics Support
    email: bcsupport@microsoft.com
    url: https://dynamics.microsoft.com/support/
  license:
    name: Microsoft APIs Terms of Use
    url: https://learn.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
  termsOfService: https://learn.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
servers:
- url: https://api.businesscentral.dynamics.com/v2.0/{environment}/api/microsoft/automation/v2.0
  description: Business Central Online Automation API
  variables:
    environment:
      default: production
      description: The name of the Business Central environment
- url: https://{server}:{port}/{instance}/api/microsoft/automation/v2.0
  description: Business Central On-Premises Automation API
  variables:
    server:
      default: localhost
      description: The on-premises server hostname
    port:
      default: '7048'
      description: The OData services port
    instance:
      default: BC
      description: The Business Central server instance name
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Configuration Packages
  description: Manage RapidStart configuration packages
paths:
  /companies({company_id})/configurationPackages:
    get:
      summary: List Configuration Packages
      description: Returns a list of RapidStart configuration packages.
      operationId: listConfigurationPackages
      tags:
      - Configuration Packages
      parameters:
      - $ref: '#/components/parameters/company_id'
      responses:
        '200':
          description: Successfully retrieved configuration packages
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/ConfigurationPackage'
              examples:
                Listconfigurationpackages200Example:
                  summary: Default listConfigurationPackages 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - id: abc123
                      code: example_value
                      packageName: example_value
                      languageId: '500123'
                      productVersion: example_value
                      processingOrder: 10
                      excludeConfigurationTables: true
                      numberOfTables: 10
                      numberOfRecords: 10
                      numberOfErrors: 10
                      importStatus: ' '
                      applyStatus: ' '
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: Create a Configuration Package
      description: Creates a new RapidStart configuration package record.
      operationId: createConfigurationPackage
      tags:
      - Configuration Packages
      parameters:
      - $ref: '#/components/parameters/company_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - code
              - packageName
              properties:
                code:
                  type: string
                  description: The configuration package code
                packageName:
                  type: string
                  description: The configuration package name
            examples:
              CreateconfigurationpackageRequestExample:
                summary: Default createConfigurationPackage request
                x-microcks-default: true
                value:
                  code: example_value
                  packageName: example_value
      responses:
        '201':
          description: Configuration package created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationPackage'
              examples:
                Createconfigurationpackage201Example:
                  summary: Default createConfigurationPackage 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    code: example_value
                    packageName: example_value
                    languageId: '500123'
                    productVersion: example_value
                    processingOrder: 10
                    excludeConfigurationTables: true
                    numberOfTables: 10
                    numberOfRecords: 10
                    numberOfErrors: 10
                    importStatus: ' '
                    applyStatus: ' '
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /companies({company_id})/configurationPackages({package_id})/file('{code}')/content:
    patch:
      summary: Upload Rapidstart Package File
      description: Uploads the RapidStart package file content.
      operationId: uploadConfigurationPackageFile
      tags:
      - Configuration Packages
      parameters:
      - $ref: '#/components/parameters/company_id'
      - name: package_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        example: '500123'
      - name: code
        in: path
        required: true
        schema:
          type: string
        example: example_value
      - $ref: '#/components/parameters/ifMatch'
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
            examples:
              UploadconfigurationpackagefileRequestExample:
                summary: Default uploadConfigurationPackageFile request
                x-microcks-default: true
                value: example_value
      responses:
        '200':
          description: Package file uploaded
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /companies({company_id})/configurationPackages({package_id})/Microsoft.NAV.import:
    post:
      summary: Import a Configuration Package
      description: Imports the uploaded RapidStart configuration package.
      operationId: importConfigurationPackage
      tags:
      - Configuration Packages
      parameters:
      - $ref: '#/components/parameters/company_id'
      - name: package_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        example: '500123'
      responses:
        '204':
          description: Import initiated
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /companies({company_id})/configurationPackages({package_id})/Microsoft.NAV.apply:
    post:
      summary: Apply a Configuration Package
      description: Applies the imported RapidStart configuration package.
      operationId: applyConfigurationPackage
      tags:
      - Configuration Packages
      parameters:
      - $ref: '#/components/parameters/company_id'
      - name: package_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        example: '500123'
      responses:
        '204':
          description: Apply initiated
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    ifMatch:
      name: If-Match
      in: header
      required: true
      description: ETag value for optimistic concurrency control
      schema:
        type: string
    company_id:
      name: company_id
      in: path
      required: true
      description: The unique identifier of the company
      schema:
        type: string
        format: uuid
  responses:
    Unauthorized:
      description: Unauthorized - authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          example: example_value
    ConfigurationPackage:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: abc123
        code:
          type: string
          description: The package code
          example: example_value
        packageName:
          type: string
          description: The package name
          example: example_value
        languageId:
          type: integer
          example: '500123'
        productVersion:
          type: string
          example: example_value
        processingOrder:
          type: integer
          example: 10
        excludeConfigurationTables:
          type: boolean
          example: true
        numberOfTables:
          type: integer
          readOnly: true
          example: 10
        numberOfRecords:
          type: integer
          readOnly: true
          example: 10
        numberOfErrors:
          type: integer
          readOnly: true
          example: 10
        importStatus:
          type: string
          readOnly: true
          enum:
          - ' '
          - InProgress
          - Completed
          - Error
          example: ' '
        applyStatus:
          type: string
          readOnly: true
          enum:
          - ' '
          - InProgress
          - Completed
          - Error
          example: ' '
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication via Microsoft Entra ID
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://api.businesscentral.dynamics.com/.default: Access Business Central Automation APIs
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://api.businesscentral.dynamics.com/.default: Access Business Central Automation APIs
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Automation API Documentation
  url: https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/itpro-introduction-to-automation-apis