Actions86
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Environment Actions
- Image Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Setting Actions
- Stack Actions
- System Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Config → Get
AI-generatedOverview
This node operation retrieves a specific Docker Swarm config by its ID from a specified environment in Portainer. It is useful for managing and inspecting configuration data used in Docker Swarm services, allowing users to fetch details of a config for monitoring or automation purposes.
Use Case Examples
- Fetch a Docker Swarm config by its ID to inspect its details before updating or deleting it.
- Retrieve configuration data from a specific environment to use in deployment automation workflows.
Properties
| Name | Meaning |
|---|---|
| Environment ID | The ID of the environment/endpoint in Portainer where the config resides. |
| Config ID | The ID of the Docker Swarm config to retrieve. |
| 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- The unique identifier of the Docker Swarm config.name- The name of the Docker Swarm config.data- Base64 encoded data content of the config.labels- Labels associated with the config for categorization or metadata.createdAt- Timestamp when the config was created.updatedAt- Timestamp when the config was last updated.
Dependencies
- Portainer API with an API key credential for authentication
Troubleshooting
- Ensure the Environment ID and Config ID are correct and exist in the Portainer instance to avoid 'not found' errors.
- Check network connectivity and proxy settings if requests time out or fail to reach the Portainer API.
- If SSL certificate validation fails, enable the 'Ignore SSL Issues' option to bypass certificate errors, but be aware of security risks.
Links
- Portainer API - Docker Swarm Configs - Official documentation for managing Docker Swarm configs via Portainer API.