Coolify icon

Coolify

Interact with Coolify API
Join our community

Actions36

Overview

This node integrates with the Coolify API to manage applications and related resources on Coolify's platform. Specifically, the "Create (Private - Deploy Key)" operation under the "Application" resource allows users to create a new application deployment using a private SSH deploy key for accessing a Git repository.

Typical use cases include automating deployment workflows where you want to programmatically create an application in Coolify that pulls source code from a private Git repository secured by an SSH deploy key. For example, this can be used in CI/CD pipelines to spin up or update applications without manual intervention.

Properties

Name Meaning
Server Name or ID Select the target server where the application will be deployed. Can choose from a list or specify an ID via expression.
Project Name or ID Select the project under which the application will be created. Can choose from a list or specify an ID via expression.
Name The name of the application to be created.
Repository URL The Git repository URL containing the application's source code.
Deploy Key The SSH deploy key (private key) used to access the private Git repository securely.
Branch The branch of the repository to deploy. Defaults to "main".

Output

The node outputs JSON data representing the result of the application creation request to the Coolify API. This typically includes details about the newly created application such as its ID, status, configuration, and other metadata returned by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Coolify API, authenticated via an API key credential configured in n8n.
  • The node depends on the Coolify API endpoints for servers, projects, and application management.
  • Network connectivity to the Coolify service is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect server or project IDs may lead to "not found" errors.
    • Providing an invalid or improperly formatted SSH deploy key can cause deployment failures.
    • Repository URL must be accessible and valid; otherwise, the deployment will fail.

  • Error messages:

    • "The resource \"application\" is not implemented!" — indicates a misconfiguration or unsupported resource selection.
    • "The operation \"createPrivateDeployKey\" is not implemented!" — indicates the selected operation is not available in the current node version.
    • API errors related to authorization or resource existence will be passed through from the Coolify API and should be checked against the API documentation.

To resolve these, verify credentials, ensure correct input values, and confirm repository accessibility.

Links and References

Discussion