Microsoft Dynamics NAV Storage API

openapi: 3.2.0
info:
  title: Business Central Administration Center Storage API
  description: REST API for programmatic administration of Dynamics 365 Business Central environments. Enables querying and managing production and sandbox environments, setting up administrative notifications, viewing tenant telemetry, managing apps, scheduling updates, and performing environment operations such as copy, rename, restore, and delete.
  version: '2.28'
  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/admin/v2.28
  description: Business Central Administration Center
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Storage
  description: View storage usage and quotas
paths:
  /applications/{applicationFamily}/environments/{environmentName}/usedstorage:
    get:
      summary: Get Environment Storage Usage
      description: Returns used storage information for the specified environment.
      operationId: getEnvironmentStorage
      tags:
      - Storage
      parameters:
      - $ref: '#/components/parameters/applicationFamily'
      - $ref: '#/components/parameters/environmentName'
      responses:
        '200':
          description: Successfully retrieved storage usage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsedStorage'
              examples:
                Getenvironmentstorage200Example:
                  summary: Default getEnvironmentStorage 200 response
                  x-microcks-default: true
                  value:
                    environmentType: example_value
                    environmentName: example_value
                    applicationFamily: example_value
                    databaseStorageInKilobytes: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /environments/usedstorage:
    get:
      summary: Get Storage Usage for All Environments
      description: Returns storage usage information for all environments.
      operationId: getAllEnvironmentsStorage
      tags:
      - Storage
      responses:
        '200':
          description: Successfully retrieved storage usage
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/UsedStorage'
              examples:
                Getallenvironmentsstorage200Example:
                  summary: Default getAllEnvironmentsStorage 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - environmentType: example_value
                      environmentName: example_value
                      applicationFamily: example_value
                      databaseStorageInKilobytes: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /environments/quotas:
    get:
      summary: Get Allowed Quotas
      description: Returns the different types of quotas and their limits.
      operationId: getQuotas
      tags:
      - Storage
      responses:
        '200':
          description: Successfully retrieved quotas
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quotas'
              examples:
                Getquotas200Example:
                  summary: Default getQuotas 200 response
                  x-microcks-default: true
                  value:
                    environmentsCount:
                      production: 10
                      sandbox: 10
                    storageInKilobytes:
                      default: 10
                      userLicenses: 10
                      additionalCapacity: 10
                      total: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    environmentName:
      name: environmentName
      in: path
      required: true
      description: The name of the environment
      schema:
        type: string
    applicationFamily:
      name: applicationFamily
      in: path
      required: true
      description: The application family (e.g., BusinessCentral)
      schema:
        type: string
        default: BusinessCentral
  schemas:
    Quotas:
      type: object
      properties:
        environmentsCount:
          type: object
          properties:
            production:
              type: integer
              description: Maximum number of production environments
            sandbox:
              type: integer
              description: Maximum number of sandbox environments
          example: example_value
        storageInKilobytes:
          type: object
          properties:
            default:
              type: integer
              description: Default storage allowance
            userLicenses:
              type: integer
              description: Storage based on user licenses
            additionalCapacity:
              type: integer
              description: Storage from purchased add-ons
            total:
              type: integer
              description: Total allowed storage
          example: example_value
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: A stable error code describing the type and nature of the error
          example: example_value
        message:
          type: string
          description: A readable description of the error and cause
          example: example_value
        target:
          type: string
          description: Information about what part of the request caused the error
          example: example_value
        extensionData:
          type: object
          description: Additional key/value information about the error
          additionalProperties: true
          example: example_value
        clientError:
          type: array
          description: Nested list of error objects with more details
          items:
            $ref: '#/components/schemas/ErrorResponse'
          example: []
    UsedStorage:
      type: object
      properties:
        environmentType:
          type: string
          example: example_value
        environmentName:
          type: string
          example: example_value
        applicationFamily:
          type: string
          example: example_value
        databaseStorageInKilobytes:
          type: integer
          format: int64
          description: Used database storage in kilobytes
          example: 10
  responses:
    Unauthorized:
      description: Unauthorized - authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  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 Admin APIs
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://api.businesscentral.dynamics.com/.default: Access Business Central Admin APIs
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Administration Center API Documentation
  url: https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/administration-center-api