Portainer icon

Portainer

Interact with Portainer via API

Actions190

Endpoints → Endpoint Inspect

AI-generated

Overview

This node interacts with the Portainer API to inspect a specific environment endpoint by its identifier. It is useful for retrieving detailed information about a particular environment (endpoint) managed within Portainer, such as its configuration and status. Practical applications include automating infrastructure management workflows, monitoring environment details, or integrating Portainer data into other systems.

Properties

Name Meaning
Id Environment (Endpoint) identifier; a required numeric value specifying which endpoint to inspect

Output

The node outputs JSON data containing detailed information about the specified environment endpoint. This typically includes properties describing the endpoint's configuration, status, and metadata as returned by the Portainer API. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • The node expects the base URL of the Portainer instance to be configured in the credentials.
  • The node uses standard HTTP headers for JSON communication (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Invalid or missing Id: Ensure the "Id" property is provided and corresponds to a valid environment endpoint in Portainer.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Connection issues: Confirm the Portainer base URL is reachable from the n8n instance.
  • Unexpected API responses: Check if the Portainer API version matches the node expectations and that the endpoint exists.

Links and References

Discussion