Docker icon

Docker

Interact with Docker via Portainer API

Actions107

Overview

This node allows users to delete a Docker service via the Portainer API. It is useful in scenarios where you manage containerized applications and need to programmatically remove specific services from your Docker environment managed through Portainer. For example, if a service is no longer needed or must be replaced, this node can automate its deletion based on the service ID or name.

Properties

Name Meaning
EndpointID Name or ID The identifier of the Portainer endpoint to access. You can select from a list of available endpoints or specify an ID using an expression. This determines which Docker environment the service will be deleted from.
Id The ID or name of the Docker service to delete. This is required to specify exactly which service should be removed.

Output

The node outputs JSON data representing the response from the Portainer API after attempting to delete the specified Docker service. Typically, this will confirm whether the deletion was successful or provide error details if it failed. There is no binary output.

Dependencies

  • Requires a valid Portainer API URL and an associated API authentication token configured as credentials in n8n.
  • The node depends on the Portainer API being accessible at the specified endpoint.
  • Uses the Portainer API /api/endpoints to load available endpoints dynamically.

Troubleshooting

  • Common issues:

    • Incorrect or missing endpoint ID may cause failure to connect to the correct Docker environment.
    • Invalid or non-existent service ID/name will result in errors from the Portainer API indicating the service could not be found.
    • Network connectivity problems or incorrect API credentials will prevent successful API calls.
  • Error messages:

    • "Service not found" — Verify that the service ID or name is correct and exists on the selected endpoint.
    • "Unauthorized" or "Authentication failed" — Check that the API key credential is valid and has sufficient permissions.
    • "Endpoint not found" — Ensure the endpoint ID corresponds to an existing Portainer endpoint.

Links and References

Discussion