Portainer icon

Portainer

Work with Portainer API data to manage Docker

Actions86

Node → Inspect

AI-generated

Overview

This node interacts with the Portainer API to inspect details of a specific Docker Swarm node within a given environment. It is useful for retrieving detailed information about a node's configuration and status in a Docker Swarm cluster managed by Portainer. For example, it can be used to monitor node health, check labels, roles, and availability, or troubleshoot node-related issues in a container orchestration setup.

Use Case Examples

  1. Inspect a Docker Swarm node by providing the environment ID and node ID to get detailed node information.
  2. Use this node to fetch node details for monitoring or automation workflows in Docker Swarm environments managed via Portainer.

Properties

Name Meaning
Environment ID The ID of the environment/endpoint in Portainer where the node exists. This is required to specify which Docker environment to query.
Node ID The ID of the Docker Swarm node to inspect. This uniquely identifies the node within the specified environment.
Request Options Additional HTTP request options such as batching, SSL certificate validation, proxy settings, and timeout configurations to customize the API request behavior.

Output

JSON

  • body - The JSON response body containing detailed information about the inspected Docker Swarm node.

Dependencies

  • Portainer API access with an API key credential

Troubleshooting

  • Ensure the environment ID and node ID are correct and correspond to existing resources in Portainer.
  • Check network connectivity and proxy settings if the request fails to reach the Portainer API.
  • If SSL validation errors occur, consider enabling the option to ignore SSL issues, but be aware of security implications.
  • Verify that the API key credential has sufficient permissions to access node details in the specified environment.

Links

Discussion