Overview

This node operation retrieves detailed information about a specific edge computing group in Portainer by its unique Edge Group ID. It is useful for managing and monitoring edge computing groups within a Docker environment managed by Portainer, allowing users to fetch the current configuration and status of an edge group.

Use Case Examples

1. Fetch details of an edge computing group by providing its Edge Group ID to monitor its endpoints and tags.
2. Use this operation to verify the configuration of an existing edge group before updating or deleting it.

Properties

Output

JSON

• id - The unique identifier of the edge group.
• name - The name of the edge computing group.
• dynamic - Indicates if the group is dynamic (tag-based) or static.
• tagIds - List of tag IDs associated with the group if dynamic.
• endpoints - List of endpoint IDs associated with the group if static.
• createdAt - Timestamp when the edge group was created.
• updatedAt - Timestamp when the edge group was last updated.

Dependencies

• Portainer API with an API key credential for authentication

Troubleshooting

• Ensure the Edge Group ID is correct and exists in Portainer to avoid 'not found' errors.
• Check network connectivity and proxy settings if requests time out or fail.
• If SSL certificate validation fails, consider enabling 'Ignore SSL Issues' option cautiously.

Links

• Portainer Edge Groups API Documentation - Official API documentation for managing edge groups in Portainer.