mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation, Ingress List Ingresses under the Domain resource, retrieves a list of ingress resources from the mittwald mStudio API. It allows users to filter and paginate through ingresses based on various criteria such as project ID, certificate ID, hostname substring, and app installation ID.

Typical use cases include:

  • Fetching all ingress configurations related to a specific project or application.
  • Filtering ingresses by associated certificates or hostnames for monitoring or management.
  • Paginating through large sets of ingress data to process or display in batches.

For example, a user might want to list all ingresses linked to a particular project to audit domain routing rules or to find all ingresses using a certain SSL certificate.

Properties

Name Meaning
Project Id ID of the Project to list Ingresses for.
Certificate Id ID of the Certificate to list Ingresses for.
Hostname Substring Substring filter to retrieve only ingresses whose hostnames contain this substring.
App Installation Id ID of the AppInstallation to list Ingresses for.
Limit Maximum number of ingress resources to return in the response (default 10000).
Skip Number of items to skip in the result set; should be a multiple of limit (default 0).
Page Page number to display; functions similarly to skip. If both are set, skip is used.

Output

The node outputs JSON data containing the list of ingress resources matching the query parameters. Each item in the output array represents an ingress with its associated properties as returned by the mittwald mStudio API.

No binary data output is indicated.

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 standard HTTP headers for JSON content negotiation (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Empty results: Ensure that the filter parameters (e.g., projectId, certificateId) are correct and correspond to existing resources.
  • Pagination issues: When using skip and limit, ensure skip is a multiple of limit to avoid unexpected results.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • API rate limits or connectivity problems: Check network connectivity and API usage quotas.

Links and References

Discussion