mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

The node interacts with the mittwald mStudio API to update a container stack. Specifically, it updates services and volumes associated with an existing stack identified by its Stack Id. This operation is useful for managing containerized applications where you need to modify or refresh the configuration of running services and attached volumes within a stack.

Common scenarios include:

  • Updating service definitions or configurations in a container stack.
  • Adding, modifying, or detaching volumes from a stack.
  • Recreating services to apply changes without deleting the entire stack.

Practical example: You have a container stack running multiple microservices and want to update one or more services' configurations or add new volumes without redeploying the entire stack manually.

Properties

Name Meaning
Stack Id The unique identifier of the container stack to update.
Recreate Boolean flag indicating whether to recreate the services belonging to the stack (true/false).
Services JSON object defining the services to update within the stack.
Volumes JSON object defining the volumes belonging to the stack. Removing volumes detaches them; deletion must be explicit.

Output

The node outputs JSON data representing the response from the mittwald mStudio API after attempting to update the container stack. This typically includes status information about the updated stack, services, and volumes.

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 API requests.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Invalid Stack Id: If the provided Stack Id does not exist or is incorrect, the API will likely return an error. Verify the Stack Id before running the node.
  • Malformed JSON in Services or Volumes: Since these properties expect JSON input, invalid JSON syntax will cause parsing errors. Ensure valid JSON format.
  • API Authentication Errors: Missing or invalid API credentials will result in authentication failures. Confirm that the API key credential is correctly set up.
  • Recreate Flag Misuse: Setting Recreate to false may cause updates not to apply if the API requires recreation for certain changes. Try toggling this flag if updates do not take effect.

Links and References

Discussion