API changes for v2 API, October 17 to October 24

This week's update to the mittwald API includes changes to the request parameter types for various endpoints, making the 'appInstallationId', 'cronjobId', 'customerId', 'fileId', and 'projectId' parameters more flexible, alongside the addition of new endpoints and required response properties for better clarity and functionality.

Breaking changes

This document contains changes that can under certain circumstances be considered breaking. Please review the changes carefully.

While we generally strive to avoid breaking changes in accordance with our API stability guarantees, we occasionally might perform changes that would be considered breaking in the strictest sense of the term, but we do not consider as breaking in a practical sense. We will always provide ample notice and documentation for such changes.

Summary

• The type/format of the appInstallationId, cronjobId, customerId, fileId and projectId request parameters have changed from 'string'/'uuid' to 'string' for all operations. On a specification level, this might be considered a breaking change; however, this change only reflects the actual behavior of the API, and does not affect the generated client libraries.

• The response property 'chargeability' has become required for the status '200' in the following operations:

  • GET /v2/customers/{customerId}/extensions/{extensionId} (extension-get-extension-instance-for-customer)
  • GET /v2/extension-instances/{extensionInstanceId} (extension-get-extension-instance)
  • GET /v2/projects/{projectId}/extensions/{extensionId} (extension-get-extension-instance-for-project)

• The required property 'chargeability/reasons/isNonChargeableCustomer' has been added to the response with the '200' status in the following operations:

  • GET /v2/customers/{customerId}/extensions/{extensionId} (extension-get-extension-instance-for-customer)
  • GET /v2/extension-instances/{extensionInstanceId} (extension-get-extension-instance)
  • GET /v2/projects/{projectId}/extensions/{extensionId} (extension-get-extension-instance-for-project)
  • GET /v2/extension-instances (extension-list-extension-instances)

• The optional property '/items/scheduledDeletionDate' has been added to the response with the '200' status in the following operations:

  • GET /v2/domains (domain-list-domains)
  • GET /v2/domains/{domainId} (domain-get-domain)
  • GET /v2/projects/{projectId}/domains (deprecated-domain-list-domains)

• The following endpoints have been added:

  • DELETE /v2/domains/{domainId}/scheduled-deletion (domain-cancel-scheduled-deletion)
  • POST /v2/domains/{domainId}/scheduled-deletion (domain-create-scheduled-deletion)

Disclaimer: This summary is AI-generated. If you find any discrepancies, please refer to the detailed changes below.

Detailed changes

Changes in "Trigger an uninstallation process for an app installation"

• ⚠️ Breaking: for the 'path' request parameter 'appInstallationId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the DELETE/v2/app-installations/{appInstallationId}/ endpoint.

Changes in "Get an app installation"

• ⚠️ Breaking: for the 'path' request parameter 'appInstallationId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the GET/v2/app-installations/{appInstallationId}/ endpoint.

Changes in "Update properties belonging to an app installation"

• ⚠️ Breaking: for the 'path' request parameter 'appInstallationId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the PATCH/v2/app-installations/{appInstallationId}/ endpoint.

Changes in "Create linkage between an app installation and a MySQL database"

• ⚠️ Breaking: for the 'path' request parameter 'appInstallationId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the PATCH/v2/app-installations/{appInstallationId}/database/ endpoint.

Changes in "Replace a MySQL Database with another MySQL Database"

• ⚠️ Breaking: for the 'path' request parameter 'appInstallationId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the PATCH/v2/app-installations/{appInstallationId}/database/replace/ endpoint.

Changes in "Remove linkage between an app installation and a Database"

• ⚠️ Breaking: for the 'path' request parameter 'appInstallationId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the DELETE/v2/app-installations/{appInstallationId}/databases/{databaseId}/ endpoint.

Changes in "Create linkage between an app installation and database users"

• ⚠️ Breaking: for the 'path' request parameter 'appInstallationId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the PUT/v2/app-installations/{appInstallationId}/databases/{databaseId}/users/ endpoint.

Changes in "Get the missing requirements of an appInstallation for a specific target app version"

• ⚠️ Breaking: for the 'path' request parameter 'appInstallationId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the GET/v2/app-installations/{appInstallationId}/missing-dependencies/ endpoint.

Changes in "Get the installed system software' for a specific app installation`"

• ⚠️ Breaking: for the 'path' request parameter 'appInstallationId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the GET/v2/app-installations/{appInstallationId}/systemSoftware/ endpoint.

Changes in "Delete a cronjob"

• ⚠️ Breaking: for the 'path' request parameter 'cronjobId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the DELETE/v2/cronjobs/{cronjobId}/ endpoint.

Changes in "Get a cronjob"

• ⚠️ Breaking: for the 'path' request parameter 'cronjobId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the GET/v2/cronjobs/{cronjobId}/ endpoint.

Changes in "Update a cronjob"

• ⚠️ Breaking: for the 'path' request parameter 'cronjobId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the PATCH/v2/cronjobs/{cronjobId}/ endpoint.

Changes in "Update a cronjob's app id"

• ⚠️ Breaking: for the 'path' request parameter 'cronjobId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the PATCH/v2/cronjobs/{cronjobId}/app-id/ endpoint.

Changes in "List cronjob executions belonging to a cronjob"

• ⚠️ Breaking: for the 'path' request parameter 'cronjobId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the GET/v2/cronjobs/{cronjobId}/executions/ endpoint.

Changes in "Trigger a cronjob"

• ⚠️ Breaking: for the 'path' request parameter 'cronjobId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the POST/v2/cronjobs/{cronjobId}/executions/ endpoint.

Changes in "Get a cronjob execution"

• ⚠️ Breaking: for the 'path' request parameter 'cronjobId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the GET/v2/cronjobs/{cronjobId}/executions/{executionId}/ endpoint.

Changes in "Abort a cronjob execution"

• ⚠️ Breaking: for the 'path' request parameter 'cronjobId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the POST/v2/cronjobs/{cronjobId}/executions/{executionId}/actions/abort/ endpoint.

Changes in "Leave a Customer"

• ⚠️ Breaking: for the 'path' request parameter 'customerId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the POST/v2/customers/{customerId}/actions/leave/ endpoint.

Changes in "Create a customer invite"

• ⚠️ Breaking: for the 'path' request parameter 'customerId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the POST/v2/customers/{customerId}/invites/ endpoint.

Changes in "Get a File"

• ⚠️ Breaking: for the 'path' request parameter 'fileId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the GET/v2/files/{fileId}/ endpoint.

Changes in "Get a File's meta"

• ⚠️ Breaking: for the 'path' request parameter 'fileId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the GET/v2/files/{fileId}/meta/ endpoint.

Changes in "Get a File with user-friendly url"

• ⚠️ Breaking: for the 'path' request parameter 'fileId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the GET/v2/files/{fileId}/{fileName}/ endpoint.

Changes in "List app installations belonging to a Project"

• ⚠️ Breaking: for the 'path' request parameter 'projectId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the GET/v2/projects/{projectId}/app-installations/ endpoint.

Changes in "Request an app installation"

• ⚠️ Breaking: for the 'path' request parameter 'projectId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the POST/v2/projects/{projectId}/app-installations/ endpoint.

Changes in "List cronjobs belonging to a Project"

• ⚠️ Breaking: for the 'path' request parameter 'projectId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the GET/v2/projects/{projectId}/cronjobs/ endpoint.

Changes in "Create a cronjob"

• ⚠️ Breaking: for the 'path' request parameter 'projectId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the POST/v2/projects/{projectId}/cronjobs/ endpoint.

Changes in "Create a ProjectInvite"

• ⚠️ Breaking: for the 'path' request parameter 'projectId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the POST/v2/projects/{projectId}/invites/ endpoint.

Changes in "Leave a Project"

• ⚠️ Breaking: for the 'path' request parameter 'projectId', the type/format was changed from 'string'/'uuid' to 'string'/''

For details, refer to the POST/v2/projects/{projectId}/leave/ endpoint.

Changes in "Get the extension instance of a specific customer and extension, if existing"

• the response property 'chargeability' became required for the status '200'

• added the required property 'chargeability/reasons/isNonChargeableCustomer' to the response with the '200' status

For details, refer to the GET/v2/customers/{customerId}/extensions/{extensionId}/ endpoint.

Changes in "List Domains"

• added the optional property '/items/scheduledDeletionDate' to the response with the '200' status

For details, refer to the GET/v2/domains/ endpoint.

Changes in "Get a Domain"

• added the optional property 'scheduledDeletionDate' to the response with the '200' status

For details, refer to the GET/v2/domains/{domainId}/ endpoint.

Changes in "Cancel a scheduled deletion of a Domain"

• endpoint added

For details, refer to the DELETE/v2/domains/{domainId}/scheduled-deletion/ endpoint.

Changes in "Create a scheduled deletion of a Domain"

• endpoint added

For details, refer to the POST/v2/domains/{domainId}/scheduled-deletion/ endpoint.

Changes in "List extension instances"

• the response property '/items/chargeability' became required for the status '200'

• added the required property '/items/chargeability/reasons/isNonChargeableCustomer' to the response with the '200' status

For details, refer to the GET/v2/extension-instances/ endpoint.

Changes in "Get an extension instance"

• the response property 'chargeability' became required for the status '200'

• added the required property 'chargeability/reasons/isNonChargeableCustomer' to the response with the '200' status

For details, refer to the GET/v2/extension-instances/{extensionInstanceId}/ endpoint.

Changes in "List Domains belonging to a Project"

• added the optional property '/items/scheduledDeletionDate' to the response with the '200' status

For details, refer to the GET/v2/projects/{projectId}/domains/ endpoint.

Changes in "Get the extension instance of a specific project and extension, if existing"

• the response property 'chargeability' became required for the status '200'

• added the required property 'chargeability/reasons/isNonChargeableCustomer' to the response with the '200' status

For details, refer to the GET/v2/projects/{projectId}/extensions/{extensionId}/ endpoint.

Client package releases

mittwald PHP SDK Release v2.1.156

The mittwald PHP SDK has released version v2.1.156, introducing several new features and improvements. This release focuses on enhancing domain management capabilities and improving request and response handling.

New Features

• Domain Scheduled Deletion Management:
  • Introduced the ability to create and cancel scheduled deletions for domains using CreateScheduledDeletion and CancelScheduledDeletion requests.
  • Enhanced domain schema with scheduledDeletionDate for improved lifecycle management.

Fixes and Improvements

• Request and Response Models:
  • Removed format: "uuid" from certain request models for better validation.
  • Improved validation response handling to ensure proper error types are returned for bad or excessive requests.

New Response Types

• Implemented new response types for error handling in scheduled deletion operations, including:
  • CancelScheduledDeletionBadRequestResponse
  • CancelScheduledDeletionTooManyRequestsResponse
  • CreateScheduledDeletionBadRequestResponse
• Enhanced default response handling for these operations.

Updates in Domain and Marketplace Schemas

• Enhanced Domain schema with scheduledDeletionDate.
• Added Chargeability handling in ExtensionInstance schema for better data integrity.

These updates aim to streamline domain management and improve the overall API experience with enhanced validation and error handling. For more details, visit the release page.

mittwald JavaScript SDK Release 4.244.0

The mittwald JavaScript SDK has been updated to version 4.244.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub here.

mittwald JavaScript SDK Release 4.243.0

The mittwald JavaScript SDK version 4.243.0 has been released on October 21, 2025. This update includes a feature enhancement with an updated generated client. For more details, you can view the release on GitHub.

mittwald JavaScript SDK Release 4.242.3

The mittwald JavaScript SDK has been updated to version 4.242.3. This release includes a version bump for the package root. For more details, you can view the release on GitHub: mittwald/api-client-js/releases/tag/4.242.3.

mittwald JavaScript SDK Release 4.242.2

The mittwald JavaScript SDK has been updated to version 4.242.2. This release includes a version bump for the package root. For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.242.2.

mittwald JavaScript SDK Release 4.242.1

The mittwald JavaScript SDK has been updated to version 4.242.1. This release includes a version bump for the package root. For more details, you can view the release on GitHub here.