mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

The node interacts with the mittwald mStudio API to declare or update a container stack configuration. Specifically, the "Container Declare Stack" operation allows users to create or modify a stack by specifying its ID along with associated services and volumes. This is useful in scenarios where infrastructure as code or container orchestration needs to be managed programmatically, such as deploying multi-container applications or managing persistent storage volumes within a stack.

Practical examples include:

  • Creating a new container stack with defined services and volumes.
  • Updating an existing stack's services or volumes.
  • Detaching volumes from a stack by removing them from the configuration (note that deletion of volumes must be done explicitly).

Properties

Name Meaning
Stack Id The unique identifier of the container stack to create or update.
Services JSON object defining the services belonging to the stack. This should be a valid JSON structure representing service configurations.
Volumes JSON object defining the volumes associated with the stack. Removing volumes here detaches them; explicit deletion requires separate action.

Output

The node outputs JSON data reflecting the response from the mittwald mStudio API after declaring or updating the container stack. This typically includes details about the stack's current state, services, and volumes as acknowledged by the API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de for all requests.
  • The node depends on the @devlikeapro/n8n-openapi-node package for building request properties and handling OpenAPI specifications.

Troubleshooting

  • Invalid JSON in Services or Volumes: Since these properties expect JSON input, malformed JSON will cause errors. Ensure the JSON syntax is correct before execution.
  • Authentication Errors: Missing or invalid API credentials will result in authentication failures. Verify that the API key credential is correctly configured.
  • Stack Not Found or Permission Denied: Using an incorrect Stack Id or insufficient permissions may cause errors. Confirm the Stack Id exists and the API key has appropriate access rights.
  • Volume Deletion Confusion: Removing volumes from the volumes property only detaches them; to delete volumes, a separate explicit action is required. Users might mistakenly expect removal here to delete volumes.

Links and References

Discussion