Breaking (!) API changes for v2 API, January 30 to February 6

This week, the mittwald API introduces several changes including updates to request and response properties, the addition of new optional parameters, and modifications to existing request body formats across various endpoints.

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 POST operation at the path /v2/actions/list-ingresses-compatible-with-certificate now has an alternative request body containing only a certificateId.
• The POST operation at the path /v2/certificate-requests now has an alternative request body for the creation of 'DNS' certificates.
• Several required response properties have become optional for the status '200' in the GET operations at the paths /v2/certificates and /v2/certificates/{certificateId}:
  • certificate
  • isExpired
  • lastExpirationThresholdHit
  • validFrom
  • validTo
• A new value '3' (representing 'DNS') has been added to the enum certificateType of component certificate-request.
• The optional property dnsCertSpec has been added to the certificate-request component.
• The response property contact has become optional for the status '201' in the POST operation at the path /v2/certificate-requests.
• Non-success responses of the status '409' and '412' have been added for the POST operation at the path /v2/certificate-requests.
• The optional property /items/information/userId has been removed from the response with the '200' status in the GET operation at the path /v2/customer-invites.
• The optional property information/userId has been removed from the response with the '200' status in the GET operation at the path /v2/customer-invites/{customerInviteId}.
• The optional property information/userId has been removed from the response with the '200' status in the GET operation at the path /v2/customer-token-invite.
• The optional property /items/information/userId has been removed from the response with the '200' status in the GET operation at the path /v2/customers/{customerId}/invites.
• The optional property information/userId has been removed from the response with the '201' status in the POST operation at the path /v2/customers/{customerId}/invites.
• The optional property /items/information/userId has been removed from the response with the '200' status in the GET operation at the path /v2/project-invites.
• The optional property information/userId has been removed from the response with the '200' status in the GET operation at the path /v2/project-invites/{projectInviteId}.
• The optional property information/userId has been removed from the response with the '200' status in the GET operation at the path /v2/project-token-invite.
• The optional property /items/information/userId has been removed from the response with the '200' status in the GET operation at the path /v2/projects/{projectId}/invites.
• The optional property information/userId has been removed from the response with the '201' status in the POST operation at the path /v2/projects/{projectId}/invites.
• The optional property /items/isMailAddressInvalid has been added to the response with the '200' status in the GET operation at the path /v2/customers.
• The optional property isMailAddressInvalid has been added to the response with the '200' status in the GET operation at the path /v2/customers/{customerId}.
• A default value of '10000' has been added for the query request parameter limit in the GET operation at the path /v2/domains.
• A new optional request parameter skip has been added in the GET operation at the path /v2/domains.
• The intended functionality of parameters page and limit of the GET operation at the path /v2/domains has been fixed, it previously did not work.

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

Detailed changes

Changes in "List Ingresses compatible with a certificate"

• changed the request body to a 'oneOf' list

• moved the previous alternative-less request body into '#/components/schemas/de.mittwald.v1.ingress.ListIngressesCompatibleWithCertificateRequest'

• added the alternative '#/components/schemas/de.mittwald.v1.ingress.ListIngressesCompatibleWithCertificateIDRequest'

For details, refer to the POST/v2/actions/list-ingresses-compatible-with-certificate/ endpoint.

Changes in "Create a CertificateRequest"

• the response property 'contact' became optional for the status '201', since the new certificate requests of type '3' (DNS), do not have a contact

• added '#/components/schemas/de.mittwald.v1.ssl.CertificateRequestCreateWithDNSRequest' to the request body 'oneOf' list

• added the non-success response with the status '409'

• added the non-success response with the status '412'

For details, refer to the POST/v2/certificate-requests/ endpoint.

Changes in component "Certificate"

• added the optional property 'dnsCertSpec'

• added the new '3' (DNS) enum value to the 'certificateType' property.

• such DNS certificates do not contain previously required properties, which therefore became optional:

  • 'certificate'
  • 'isExpired'
  • 'lastExpirationThresholdHit'
  • 'validFrom'
  • 'validTo'

For details, refer to the GET/v2/certificates/{certificateId}/ endpoint.

Changes in "List Domains"

• for the 'query' request parameter 'limit', default value '10000' was added

• added the new optional 'query' request parameter 'skip'

• the intended functionality of parameters page and limit has been fixed, it previously did not work.

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

Changes in "List customer invites belonging to the executing user"

• removed the optional property '/items/information/userId' from the response with the '200' status

For details, refer to the GET/v2/customer-invites/ endpoint.

Changes in "Get a customer invite"

• removed the optional property 'information/userId' from the response with the '200' status

For details, refer to the GET/v2/customer-invites/{customerInviteId}/ endpoint.

Changes in "Get a customer invite by token"

• removed the optional property 'information/userId' from the response with the '200' status

For details, refer to the GET/v2/customer-token-invite/ endpoint.

Changes in "List Invites belonging to a Customer"

• removed the optional property '/items/information/userId' from the response with the '200' status

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

Changes in "Create a customer invite"

• removed the optional property 'information/userId' from the response with the '201' status

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

Changes in "List ProjectInvites belonging to the executing user"

• removed the optional property '/items/information/userId' from the response with the '200' status

For details, refer to the GET/v2/project-invites/ endpoint.

Changes in "Get a ProjectInvite"

• removed the optional property 'information/userId' from the response with the '200' status

For details, refer to the GET/v2/project-invites/{projectInviteId}/ endpoint.

Changes in "Get a ProjectInvite by token"

• removed the optional property 'information/userId' from the response with the '200' status

For details, refer to the GET/v2/project-token-invite/ endpoint.

Changes in "List Invites belonging to a Project"

• removed the optional property '/items/information/userId' from the response with the '200' status

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

Changes in "Create a ProjectInvite"

• removed the optional property 'information/userId' from the response with the '201' status

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

Changes in "Get all customer profiles the authenticated user has access to"

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

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

Changes in "Get a customer profile"

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

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

Client package releases

mittwald PHP SDK v2.1.180 Release Summary

The latest release of the mittwald PHP SDK, version v2.1.180, introduces several enhancements and new features focused on improving SSL certificate management and API interaction. Key updates include:

• Features:

  • Support for conflict and precondition failed responses in SSL certificate creation requests.
  • New request schemas for listing ingresses compatible with certificates.
  • Enhanced SSL certificate schema with new DNS certificate specifications and detailed statuses.

• Additions:

  • New response classes: SslCreateCertificateRequestConflictResponse and SslCreateCertificateRequestPreconditionFailedResponse.
  • New schemas: ListIngressesCompatibleWithCertificateIDRequest, CertificateRequestCreateWithDNSRequest, DNSCertStatus, and ProjectCertificateStatus.
  • Updates to existing classes to support new request types and enhance flexibility in SSL certificate requests.

• Changes:

  • Refactoring of existing classes for improved clarity and structure.
  • Nullable class properties for compatibility with optional parameters.
  • Adjusted validation schemas to prevent invalid attributes in requests.

These updates aim to enhance error handling and expand capabilities in defining requests and responses related to SSL certificates.

For more details, visit the release page.

mittwald PHP SDK Release v2.1.179

The mittwald PHP SDK has been updated to version v2.1.179. This release includes several enhancements and bug fixes aimed at improving functionality and code clarity.

Features

• MySQL Database Retrieval Enhancement: The getMySQLDatabase function in DatabaseClient and DatabaseClientImpl now includes detailed comments. These comments clarify that the method returns a MySQLDatabase resource along with its current status, and emphasize that the linked user must have a status of "ready" for a successful connection.

Bug Fixes and Improvements

• Customer Invite Schema Adjustment: The description for the avatarRefId field in the CustomerInvite class has been updated for clarity, changing from "Reference to the Project's avatar" to "Reference to the Customer's avatar."
• Invite Information Schema Simplification: The userId field, along with its associated methods and validations, has been removed from the InviteInformation class to streamline the invite process and enhance the data model.
• Code Cleanup: Deprecated properties and methods related to userId in the InviteInformation class have been removed to ensure cleaner and more maintainable code.

For more details, visit the release page.

mittwald PHP SDK Release v2.1.178

The mittwald PHP SDK has been updated to version v2.1.178. This release introduces several enhancements and changes aimed at improving functionality and user experience.

Features

• ListDomainsRequest Enhancements: The ListDomainsRequest class now supports enhanced pagination and filtering with the addition of a skip property and a default limit set to 10,000. The handling of domain search and contact hash has been restructured for better efficiency.

• Customer Schema Updates: A new boolean property, isMailAddressInvalid, has been added to the Customer class to track the validity of a customer's email address.

Changes

• ListDomainsRequest Class: The structure of the ListDomainsRequest has been refactored, introducing a skip property for improved pagination control and removing default handling for page and limit to allow for more user-defined flexibility.

• UserClient Interface and Implementation: Documentation updates include a revised description for the method of creating an API token, changing from "Store a new ApiToken." to "Create a new ApiToken."

• Customer Class: The isMailAddressInvalid property has been integrated with corresponding getter and setter methods, and the constructor and methods have been updated to include validation logic for this new property.

For more details, please visit the release page.

mittwald JavaScript SDK Release 4.296.0

The mittwald JavaScript SDK version 4.296.0 has been released on February 5, 2026. 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.295.0

The mittwald JavaScript SDK has been updated to version 4.295.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.294.0

The mittwald JavaScript SDK has been updated to version 4.294.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: mittwald JavaScript SDK 4.294.0.

mittwald JavaScript SDK Release 4.293.0

The mittwald JavaScript SDK has been updated to version 4.293.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: mittwald JavaScript SDK 4.293.0.

mittwald JavaScript SDK Release 4.292.0

The mittwald JavaScript SDK has been updated to version 4.292.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.291.0

The mittwald JavaScript SDK has been updated to version 4.291.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: mittwald JavaScript SDK 4.291.0.