Portainer icon

Portainer

Work with Portainer API data to manage Docker

Actions86

Service → Get Many

AI-generated

Overview

This node operation retrieves a list of Docker Swarm services from a specified environment in Portainer. It is useful for managing and monitoring multiple services within a Docker Swarm cluster. For example, users can list all running services to check their status or gather information for further automation or reporting.

Use Case Examples

  1. List all Docker Swarm services in environment ID 1 to monitor active services.
  2. Retrieve services with specific filters to automate scaling or updates.

Properties

Name Meaning
Environment ID The ID of the environment/endpoint in Portainer from which to retrieve the services.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration to customize the API request behavior.

Output

JSON

  • id - Unique identifier of the Docker Swarm service.
  • name - Name of the Docker Swarm service.
  • image - Docker image used by the service.
  • replicas - Number of replicas for the service.
  • createdAt - Timestamp when the service was created.
  • updatedAt - Timestamp when the service was last updated.
  • status - Current status of the service.

Dependencies

  • Portainer API with an API key credential for authentication

Troubleshooting

  • Ensure the Environment ID is correct and accessible in Portainer to avoid authorization errors.
  • Check network connectivity and proxy settings if requests time out or fail.
  • If SSL certificate validation fails, consider enabling the option to ignore SSL issues, but be aware of security risks.
  • Verify that the API key credential is valid and has sufficient permissions to list services.

Links

Discussion