Actions91
- Account Setting Actions
- Addon Actions
- Ceiling Actions
- Company Info Actions
- Device Actions
- Exercise Actions
- Feedback Actions
- File Actions
- File Type Actions
- Gender Actions
- Guest Actions
- License Actions
- Log Actions
- Payment Actions
- Permission Actions
- Relationship Actions
- Role Actions
- Service Actions
- Service Price Actions
- Social Actions
- Topic Actions
- User Actions
- Workout Execution Actions
- Worksheet Actions
Overview
The "Addon Update" operation in the GymControl node allows users to update details of an existing addon within their GymControl instance. This operation is useful for managing addons by modifying properties such as name, description, version, pricing, status flags (installed, running, up-to-date), and other metadata related to the addon.
Typical use cases include:
- Updating addon information after a new release or patch.
- Changing pricing or category details for addons offered to gym members.
- Managing addon lifecycle states like installation status or auto-update preferences.
For example, a gym administrator could use this node to update the version number and description of a workout tracking addon after deploying improvements.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the addon to update (required). |
| Options | A collection of optional fields to update on the addon: |
| - Name | The name of the addon. |
| - Description | A detailed description of the addon. |
| - Icon | URL or identifier for the addon's icon image. |
| - Readme | Text content for the addon's readme or documentation. |
| - Version | Current version string of the addon. |
| - New Version | New version string to update the addon to. |
| - Category | Category classification of the addon. |
| - Server ID | Identifier of the server associated with the addon. |
| - Container | Container name or identifier where the addon runs. |
| - Buy Price | Purchase price of the addon (number, minimum 0). |
| - Month Price | Monthly subscription price of the addon (number, minimum 0). |
| - Installed | Boolean flag indicating if the addon is installed. |
| - Running | Boolean flag indicating if the addon is currently running. |
| - Up To Date | Boolean flag indicating if the addon is up to date. |
| - Error | Boolean flag indicating if there is an error state with the addon. |
| - Auto Update | Boolean flag indicating if the addon should auto-update. |
| Show Complete Response | Boolean setting to determine whether to return the full API response or just essential data. |
Output
The node outputs JSON data representing the updated addon object returned from the GymControl API. This typically includes all current properties of the addon after the update, reflecting any changes made.
If "Show Complete Response" is enabled, the output will contain the entire API response, which may include additional metadata or status information beyond the addon data.
This node does not output binary data.
Dependencies
- Requires an active connection to a GymControl instance via an API key credential.
- The node uses the base URL and authentication token configured in the credentials to make HTTP requests to the GymControl API.
- Proper permissions on the API key are necessary to perform update operations on addons.
Troubleshooting
- Missing or invalid ID: The addon ID is required. Ensure it is provided and correctly references an existing addon.
- API authentication errors: Verify that the API key credential is valid and has sufficient permissions.
- Validation errors on fields: Some fields like prices must be non-negative numbers; ensure input values meet these constraints.
- Network or connectivity issues: Confirm that the GymControl API endpoint is reachable from n8n.
- Unexpected API responses: Enable "Show Complete Response" to get full details for debugging.
Links and References
- GymControl API Documentation (general reference for addon management endpoints)
- n8n Documentation on creating and using custom nodes with API credentials