mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node interacts with the mittwald mStudio API to create an ingress configuration for a domain. Specifically, it allows users to define hostname and routing paths associated with a project in mittwald's environment. This is useful for managing domain ingress rules programmatically, such as setting up URL path-based routing for web applications hosted on mittwald.

Practical examples include:

  • Creating ingress rules to route traffic from a custom hostname to different backend services based on URL paths.
  • Automating domain configuration as part of deployment pipelines.
  • Managing multiple projects' ingress settings centrally via n8n workflows.

Properties

Name Meaning
Hostname The domain name (hostname) for which the ingress rule will be created.
Paths A JSON array defining the list of URL paths and their targets. The default path / is always present and cannot be removed. Example: [{"target": {...}}].
Project Id The identifier of the project within mittwald where the ingress should be created.

Output

The node outputs JSON data representing the response from the mittwald mStudio API after creating the ingress. This typically includes details about the newly created ingress resource such as its ID, status, and configuration details.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authentication with the mittwald mStudio API.
  • The base URL for API requests is https://api.mittwald.de.
  • The node uses the @devlikeapro/n8n-openapi-node package to build request properties from an OpenAPI specification bundled as openapi.json.

Troubleshooting

  • Invalid or missing API credentials: Ensure that a valid API key credential is configured in n8n for authenticating with mittwald.
  • Malformed JSON in Paths property: Since paths expects a JSON string parsed into an object, invalid JSON syntax will cause errors. Validate JSON format before execution.
  • Missing required fields: All three properties (Hostname, Paths, Project Id) are required. Omitting any will result in validation errors.
  • API errors: If the mittwald API returns errors (e.g., unauthorized, not found), verify the correctness of input values and API access permissions.

Links and References

Discussion