mittwald icon

mittwald

Interact with mittwald mStudio API

Actions100

Overview

This node operation allows users to list backups associated with a specific project in the mittwald mStudio API. It is useful for retrieving and managing backup data, such as viewing available backups, filtering them by search terms, and sorting or paginating through large sets of backups. Practical applications include automating backup audits, monitoring backup availability, or integrating backup information into broader workflows.

Properties

Name Meaning
Project Id The unique identifier of the project for which backups are to be listed. (Required)
Search Term A text string to filter backups by matching against their id or description fields.
With Exports Only Boolean flag to list only backups that include exports. Defaults to true.
Sort Order Defines the order in which backups are listed: "Oldest First" or "Newest First".
Limit Maximum number of backup records to return in the response. Default is 1000.
Skip Number of items to skip before starting to collect the result set. Should be a multiple of limit.
Page Page number to display; functions similarly to skip. If both page and skip are set, skip takes precedence.

Output

The output JSON contains a list of backup objects corresponding to the specified project and filters. Each backup object includes details such as its ID, description, export status, creation date, and other metadata provided by the mittwald mStudio API. This structured data can be used downstream in workflows for reporting, further processing, or conditional logic.

If the node supports binary data output (not indicated here), it would typically represent downloadable backup files or related artifacts, but this operation focuses on listing metadata only.

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 configured API authentication.

Troubleshooting

  • Missing or invalid Project Id: The operation requires a valid project ID. Ensure the project ID is correctly provided and exists in the mittwald system.
  • API Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Pagination issues: When using skip and limit, ensure skip is a multiple of limit to avoid unexpected results.
  • Empty results: If no backups are returned, check if the project actually has backups or adjust the searchTerm and withExportsOnly filters.
  • Rate limiting or network errors: Handle API rate limits or connectivity problems by implementing retries or backoff strategies in your workflow.

Links and References

Discussion