Portainer icon

Portainer

Interact with Portainer via API

Actions190

Kubernetes → Get All Kubernetes Cluster Ingresses

AI-generated

Overview

This node operation retrieves all Kubernetes cluster ingresses for a specified environment. It is useful for users who want to list and inspect the ingress resources deployed in their Kubernetes clusters, which control external access to services within the cluster. A practical example includes monitoring or auditing ingress configurations, or integrating ingress data into workflows that automate deployment or scaling decisions.

Properties

Name Meaning
Id Environment identifier (a numeric ID) specifying which Kubernetes environment to query.
Additional Fields Optional extra parameters:
- With Services Boolean flag indicating whether to also lookup services associated with each ingress.

Output

The node outputs JSON data representing the list of Kubernetes ingresses retrieved from the specified environment. Each ingress object may include details such as metadata, rules, backend services, and optionally the associated services if requested. The output does not include binary data.

Dependencies

  • Requires an API key credential to authenticate requests to the Kubernetes environment.
  • The node depends on connectivity to the Kubernetes API server corresponding to the provided environment ID.
  • No additional external services are explicitly required beyond Kubernetes itself.

Troubleshooting

  • Common issues:
    • Invalid or missing environment ID can cause failure to retrieve ingresses.
    • Network connectivity problems to the Kubernetes API server will prevent data retrieval.
    • Insufficient permissions or authentication errors due to invalid API credentials.
  • Error messages:
    • Authentication failures typically indicate incorrect or expired API tokens; verify and update credentials.
    • "Not Found" or similar errors may mean the environment ID does not correspond to a valid Kubernetes cluster.
    • Timeout or connection errors suggest network issues; check firewall and endpoint accessibility.

Links and References

Discussion