mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation, Container List Services, interacts with the mittwald mStudio API to retrieve a list of container services within a specified project. It allows filtering and sorting of services based on various criteria such as status, stack ID, and whether the service requires recreation. This is useful for DevOps engineers or developers managing containerized applications who need to monitor or audit the state of their container services programmatically.

Practical examples:

  • Listing all running services in a specific project to monitor active workloads.
  • Filtering services that require recreation to plan maintenance or updates.
  • Searching for services by name or description to quickly locate specific deployments.
  • Paginating through large sets of services when managing extensive container environments.

Properties

Name Meaning
Project Id ID of the Project to list Services for. (Required)
Stack Id ID of the Stack to filter services by. Optional query parameter.
Status Filter services by their current status. Options: Running, Stopped, Restarting, Error, Creating, Starting.
Requires Recreate Boolean filter to include only services that require recreation.
Search Term Text search across multiple fields including id, shortId, stackId, projectId, serviceName, message, and description.
Sort Order Sort the results by description in ascending or descending order. Options: Description Asc, Description Desc.
Limit Maximum number of services to return in the response. Default is 1000.
Skip Number of items to skip in the result set. Should be a multiple of limit. Used for pagination.
Page Page number to display. Functions similarly to skip. If both are set, skip takes precedence.

Output

The node outputs a JSON array containing the list of container services matching the query parameters. Each item in the array represents a service with its associated metadata such as IDs, status, description, and other relevant details returned by the mittwald mStudio API.

If binary data were involved (not indicated here), it would typically represent files or media related to the services, but this operation focuses solely on JSON data.

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.
  • No additional external dependencies beyond the API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Invalid or missing Project Id will cause the API to reject the request.
    • Incorrect API credentials will lead to authentication errors.
    • Using incompatible combinations of skip and limit may result in unexpected pagination behavior.
    • Network connectivity issues can prevent successful API calls.

  • Error messages:

    • Authentication failures usually indicate invalid or expired API keys; verify and update credentials.
    • "Resource not found" errors suggest incorrect Project Id or Stack Id values.
    • Rate limiting errors from the API may require implementing retry logic or reducing request frequency.

Links and References

Discussion