Coolify icon

Coolify

Interact with Coolify API

Overview

The node interacts with the Coolify API to manage various resources, including databases. Specifically, for the Database - Update operation, it updates an existing database's properties such as its name, version, port, and password. This is useful in scenarios where you need to modify database configurations programmatically within an automation workflow, for example, updating connection details or version information after a deployment or migration.

Practical examples:

  • Updating the database name and port after migrating to a new server.
  • Changing the database password securely through an automated workflow.
  • Adjusting the database version to reflect an upgrade.

Properties

Name Meaning
ID The unique identifier of the database to update (required).
Name The new name to assign to the database (required).
Additional Fields Optional additional parameters to update:
  Version Version string of the database.
  Port Port number on which the database listens.
  Password Password for accessing the database (input masked for security).

Output

The node outputs a JSON array containing the updated database objects returned from the Coolify API. Each object represents the state of a database after the update operation, including all relevant fields such as ID, name, version, port, and other metadata as provided by the API.

No binary data output is involved.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing database ID will cause the update to fail.
    • Incorrect API credentials or expired tokens will result in authentication errors.
    • Providing invalid field values (e.g., non-numeric port) may cause validation errors from the API.
  • Error messages:

    • "The resource "database" is not implemented!" — indicates a misconfiguration or unsupported resource selection.
    • "The operation "update" is not implemented!" — suggests the operation name might be incorrect or not supported.
    • API response errors related to authorization or validation should be checked in the credentials and input fields respectively.

To resolve these, verify that the database ID exists, ensure correct API credentials are set up, and validate all input fields before execution.

Links and References

Discussion