Portainer icon

Portainer

Interact with Portainer via API

Actions190

Kubernetes → Get Kubernetes Dashboard

AI-generated

Overview

This node operation retrieves the Kubernetes Dashboard URL or related information for a specified Kubernetes environment. It is useful when you want to programmatically access or display the dashboard endpoint of a Kubernetes cluster managed through an environment identifier. Typical use cases include automation workflows that need to fetch and present the dashboard link for monitoring or administrative purposes.

Properties

Name Meaning
Id Environment (Endpoint) identifier. This numeric value specifies which Kubernetes environment's dashboard information to retrieve.

Output

The output will contain JSON data representing the Kubernetes Dashboard details associated with the specified environment ID. This typically includes URLs or connection info needed to access the dashboard. The exact structure depends on the API response but generally provides the necessary information to connect to the Kubernetes Dashboard.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential to authenticate requests to the Portainer API.
  • The node interacts with the Portainer API, so the Portainer service must be accessible and properly configured.
  • The base URL for the API is taken from the provided credentials.
  • The node uses standard HTTP headers for JSON content negotiation.

Troubleshooting

  • Invalid Environment ID: If the provided environment ID does not exist or is incorrect, the node may return an error or empty result. Verify the ID corresponds to a valid Kubernetes environment in Portainer.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key credential is correctly set up.
  • Network Issues: Connectivity problems to the Portainer API endpoint can cause request failures. Check network access and endpoint URL correctness.
  • API Changes: If the Portainer API changes, the node might fail to parse responses correctly. Keep the node and its dependencies updated.

Links and References

Discussion