Actions107
- Node Actions
- Network Actions
- Container Actions
- Container List
- Container Create
- Container Inspect
- Container Top
- Container Logs
- Container Changes
- Container Export
- Container Stats
- Container Resize
- Container Start
- Container Stop
- Container Restart
- Container Kill
- Container Update
- Container Rename
- Container Pause
- Container Unpause
- Container Attach
- Container Attach Websocket
- Container Wait
- Container Delete
- Container Archive Info
- Container Archive
- Put Container Archive
- Container Prune
- Image Actions
- Volume Actions
- Swarm Actions
- Secret Actions
- System Actions
- Exec Actions
- Service Actions
- Task Actions
- Config Actions
- Plugin Actions
- Distribution Actions
- Session Actions
Overview
This node allows users to interact with Docker services through the Portainer API. Specifically, the "Service Inspect" operation retrieves detailed information about a specific Docker service running on a selected endpoint managed by Portainer. This is useful for monitoring, managing, or automating workflows involving Docker services in containerized environments.
Common scenarios include:
- Fetching configuration and status details of a Docker service for auditing or reporting.
- Integrating Docker service inspection into CI/CD pipelines.
- Automating infrastructure management tasks that require service metadata.
Example: A user wants to check the current state and configuration of a service named "webapp" running on a particular Docker endpoint to decide whether to trigger an update or scale operation.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | Selects the Docker endpoint (server) managed by Portainer where the service resides. Options are dynamically loaded from available endpoints. |
| Id | The identifier or name of the Docker service to inspect. |
| Additional Fields | Optional extra parameters for the request. Currently supports: • Insert Defaults: Boolean flag to fill empty fields with default values. |
Output
The node outputs JSON data representing the full details of the inspected Docker service as returned by the Portainer API. This includes all configuration, status, and metadata fields associated with the service.
If binary data were involved (not indicated here), it would typically represent files or media related to the service, but this node focuses solely on JSON service descriptions.
Dependencies
- Requires access to a Portainer instance with API enabled.
- Needs an API authentication token credential configured in n8n to authorize requests to the Portainer API.
- The node dynamically loads available Docker endpoints from Portainer to populate the endpoint selection property.
Troubleshooting
Common issues:
- Invalid or missing endpoint ID: Ensure the selected endpoint exists and is accessible.
- Incorrect service ID or name: Verify the service identifier is correct and the service exists on the chosen endpoint.
- Authentication errors: Confirm the API key or token credential is valid and has sufficient permissions.
- Network connectivity problems between n8n and the Portainer server.
Error messages:
- Unauthorized / 401 errors: Check API credentials and permissions.
- Not Found / 404 errors: Service or endpoint does not exist; verify IDs.
- Timeout or connection refused: Network issues or Portainer server down.
Resolving these usually involves verifying credentials, endpoint/service identifiers, and network accessibility.