Actions26
Overview
The "Update Project" operation in the GateKit node allows users to modify existing project details such as the project's name, description, environment, and default status. This operation is useful when you need to keep your project metadata up-to-date or change its configuration settings without creating a new project.
Typical use cases include:
- Renaming a project to reflect a new focus or branding.
- Updating the project description to provide more accurate information.
- Changing the environment setting (development, staging, production) to match the current deployment stage.
- Setting or unsetting the project as the default one for easier access or prioritization.
For example, if you have a project initially created for development but now ready for production, you can update its environment property accordingly. Or if you want to mark a specific project as the default to streamline workflows, you can toggle the "Set as default project" option.
Properties
| Name | Meaning |
|---|---|
| Project name | The new name of the project. Optional; leave empty if no change is needed. |
| Project description | A textual description of the project. Optional; can be used to provide additional context. |
| Project environment | The environment type of the project. Options: development, staging, production. |
| Set as default project | Boolean flag to set this project as the default one (true or false). |
| Slug | The unique identifier (slug) of the project to update. Required. |
Output
The output JSON will contain the updated project data returned from the API after the update operation. This typically includes fields such as the project slug, name, description, environment, default status, and possibly timestamps or other metadata reflecting the current state of the project.
No binary data output is expected from this operation.
Dependencies
- Requires an API key credential configured in n8n to authenticate requests against the GateKit API.
- The base URL for the API is taken from the credentials configuration.
- The node sends a GET request to the endpoint
/api/v1/projects/:slugwith query parameters representing the updated fields.
Troubleshooting
- Missing required slug parameter: The update operation requires the project slug to identify which project to update. Ensure that the slug is provided and correctly spelled.
- API authentication errors: If the API key credential is missing or invalid, the request will fail. Verify that the credential is properly set up and has necessary permissions.
- Invalid environment value: The environment property must be one of the allowed options (
development,staging,production). Providing an unsupported value may cause the API to reject the request. - Empty update fields: If all optional fields (name, description, environment, isDefault) are left empty, the API might not perform any update. Provide at least one field to change.
- Network or server errors: Check connectivity and API service status if requests time out or return server errors.
Links and References
- GateKit API Documentation (for detailed API endpoints and parameters)
- n8n Documentation on HTTP Request Node (for understanding how API calls are made)
- Best Practices for Managing Projects (general guidance on project lifecycle management)