Coolify icon

Coolify

Interact with Coolify API

Overview

This node integrates with the Coolify API to manage server resources programmatically. Specifically, the "Server" resource with the "Create" operation allows users to add new servers by specifying details such as the server's name, IP address, and optional configuration fields like SSH credentials, labels, and monitoring settings.

Common scenarios for this node include automating infrastructure setup, managing server inventories, or integrating server provisioning into CI/CD pipelines. For example, a DevOps engineer could use this node to automatically register newly provisioned servers in Coolify, ensuring they are monitored and backed up according to organizational policies.

Properties

Name Meaning
Name The name of the server to be created.
IP Address The IP address of the server.
Additional Fields A collection of optional fields to further configure 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 (entered securely).
- SSH Password The SSH password for authentication (entered securely).
- Labels One or more labels to organize and categorize servers.
- Monitoring Enabled Boolean flag to enable or disable server monitoring (default is true).
- Backups Enabled Boolean flag to enable or disable server backups (default is true).

Output

The node outputs an array of JSON objects representing the created server(s) as returned by the Coolify API. Each object contains details about the server, including its assigned ID, name, IP address, and any other metadata provided or generated during creation.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the Coolify API.
  • Requires an API authentication token configured in n8n credentials to authorize requests.
  • Network access to the Coolify API endpoint must be available from the n8n environment.

Troubleshooting

  • Missing Required Fields: If "Name" or "IP Address" is not provided, the node will throw an error indicating these required parameters are missing.
  • Authentication Errors: Failure to authenticate with the Coolify API will result in authorization errors. Ensure that the API key credential is correctly configured and valid.
  • API Connectivity Issues: Network problems or incorrect API URLs can cause request failures. Verify network connectivity and API endpoint correctness.
  • Invalid SSH Credentials: Providing invalid SSH keys or passwords may cause server creation to fail if the API validates these fields.
  • Unexpected API Responses: If the Coolify API changes or returns unexpected data, the node might fail or produce incomplete output. Check API version compatibility.

Links and References

Discussion