Coolify icon

Coolify

Interact with Coolify API
Join our community

Actions36

Overview

This node integrates with the Coolify API to manage various resources related to application deployment and infrastructure. Specifically, for the Application resource with the Create (Private - GitHub App) operation, it allows users to create a new application in Coolify that is linked to a private GitHub repository via a GitHub App. This is useful for automating deployments of applications hosted on private repositories, leveraging GitHub Apps for authentication and access.

Typical use cases include:

  • Automating the creation and deployment of applications from private GitHub repositories.
  • Managing multiple applications across different servers and projects within Coolify.
  • Streamlining CI/CD workflows by programmatically creating applications tied to specific branches and repositories.

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 organized. Can choose from a list or specify an ID via expression.
Name The name to assign to the new application being created.
Repository Name or ID Choose the GitHub repository (private) to link with this application. Can select from available repositories or specify an ID.
GitHub App Name or ID Select the GitHub App to use for authenticating and accessing the private repository.
Branch Name or ID Specify the branch of the repository to deploy from. Options depend on the selected repository.

Output

The node outputs a JSON array containing the response data from the Coolify API after creating the application. This typically includes details about the newly created application such as its ID, name, associated server and project IDs, repository information, and deployment status.

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.
  • Access to GitHub repositories through GitHub Apps configured in Coolify.
  • The node dynamically loads options for servers, projects, GitHub repositories, branches, and GitHub Apps by making GET requests to the Coolify API endpoints.
  • Proper permissions must be granted to the GitHub App to access the specified private repository and branch.

Troubleshooting

  • Common issues:

    • Failure to load options (servers, projects, repositories, etc.) may indicate network issues or invalid API credentials.
    • Errors creating the application often stem from insufficient permissions of the GitHub App or incorrect repository/branch selections.
    • Providing invalid or empty required fields will cause the node to throw errors.

  • Error messages:

    • "The resource "application" is not implemented!" — indicates a misconfiguration or unsupported resource selection.
    • "The operation "createPrivateGithubApp" is not implemented!" — suggests the operation name might be misspelled or missing in the code.
    • API errors returned from Coolify usually contain descriptive messages; ensure the API key and GitHub App have correct scopes and access rights.

  • Resolutions:

    • Verify API credentials and GitHub App permissions.
    • Confirm that the repository and branch exist and are accessible.
    • Use expressions carefully when specifying IDs to avoid invalid references.

Links and References

Discussion