Coolify icon

Coolify

Interact with Coolify API
Join our community

Actions36

Overview

The node interacts with the Coolify API to manage various resources, including servers. Specifically, the "Server" resource with the "Update" operation allows users to update details of an existing server by specifying its ID and new properties. This is useful in scenarios where server configurations need to be modified dynamically, such as changing SSH credentials, updating labels for organization, or toggling monitoring and backup settings.

Practical examples:

  • Updating the SSH port or authentication method of a server after infrastructure changes.
  • Adding descriptive labels to servers for better categorization.
  • Enabling or disabling monitoring and backups based on operational requirements.

Properties

Name Meaning
ID The unique identifier of the server to update (required).
Name The new name to assign to the server (required).
Additional Fields Optional fields to further customize the server:
- Description A textual description of the server.
- SSH Port The port number used for SSH connections (default is 22).
- SSH Key The private SSH key for authentication (password type input).
- SSH Password The SSH password for authentication (password type input).
- Labels Multiple string labels to organize and categorize servers.
- Monitoring Enabled Boolean flag to enable or disable server monitoring (default true).
- Backups Enabled Boolean flag to enable or disable server backups (default true).

Output

The node outputs a JSON array containing the updated server objects returned from the Coolify API. Each object represents the server's current state after the update operation, including all its properties such as ID, name, description, SSH configuration, labels, and status flags.

No binary data output is involved.

Dependencies

  • Requires an active connection to the Coolify API via an API key credential configured in n8n.
  • The node uses internal helper functions to make authenticated HTTP requests to Coolify endpoints.
  • No additional external dependencies are required beyond the Coolify API access.

Troubleshooting

  • Common issues:
    • Invalid or missing server ID will cause the update to fail.
    • Providing incomplete or incorrect SSH credentials may result in authentication errors.
    • Network connectivity problems can prevent communication with the Coolify API.
  • Error messages:
    • "The resource "server" is not implemented!" indicates a misconfiguration or unsupported resource selection.
    • "The operation "update" is not implemented!" suggests the operation is not recognized for the selected resource.
    • API errors from Coolify (e.g., 404 Not Found, 401 Unauthorized) should be checked for correct credentials and valid server IDs.
  • Resolution tips:
    • Verify that the server ID exists and is correctly specified.
    • Ensure the API key credential is valid and has sufficient permissions.
    • Double-check SSH credentials and ports if authentication fails.
    • Confirm network access to the Coolify API endpoint.

Links and References

Discussion