Coolify icon

Coolify

Interact with Coolify API

Overview

This node interacts with the Coolify API to manage various resources including projects. Specifically, the "Update" operation for the "Project" resource allows users to modify existing project details such as its name, description, associated team, and labels. This is useful in scenarios where project metadata needs to be kept current or adjusted after creation, for example updating a project's description to reflect new goals or changing its team assignment.

Practical examples:

  • Updating a project’s name and description after a rebranding.
  • Assigning a project to a different team by updating the team ID.
  • Adding or modifying labels to organize projects better within Coolify.

Properties

Name Meaning
ID The unique identifier of the project to update (required).
Name The new name for the project (required).
Additional Fields Optional extra fields to update:
- Description A textual description of the project.
- Team ID The identifier of the team this project belongs to.
- Labels An array of labels (tags) used to organize projects.

Output

The node outputs an array of JSON objects representing the updated project(s). Each object contains the updated project data as returned from the Coolify API. The exact structure depends on the API response but typically includes fields like project ID, name, description, team ID, labels, and other metadata.

No binary data output is indicated.

Dependencies

  • Requires an active connection to the Coolify API.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The node uses internal helper functions to make HTTP requests to Coolify endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing project ID will cause the update to fail.
    • Insufficient permissions or invalid API credentials can result in authorization errors.
    • Providing invalid field values (e.g., non-existent team ID) may cause API errors.
  • Error messages:

    • "The resource "project" is not implemented!" — indicates a misconfiguration or unsupported resource selection.
    • "The operation "update" is not implemented!" — suggests the operation is not available for the selected resource.
    • API errors related to invalid input or authentication will be surfaced from the Coolify API responses.

To resolve errors:

  • Verify that the project ID exists and is correct.
  • Ensure API credentials are valid and have sufficient permissions.
  • Double-check additional fields for correctness and validity according to Coolify API documentation.

Links and References

Discussion