Coolify icon

Coolify

Interact with Coolify API
Join our community

Actions36

Overview

This node integrates with the Coolify API to manage deployments of applications. Specifically, the "Deployment" resource with the "Create" operation allows users to trigger a deployment for a specified application. This is useful in continuous deployment workflows where you want to automate pushing new versions or updates of your app.

Typical use cases include:

  • Automatically deploying an application after a successful build or code merge.
  • Forcing a redeployment even if no changes are detected.
  • Clearing cache before deployment to ensure fresh content delivery.
  • Deploying a specific commit by its ID.

For example, after pushing code to a repository, this node can be used to deploy the latest version of the app automatically.

Properties

Name Meaning
Application ID The unique identifier of the application to deploy.
Additional Fields Optional settings for deployment:
• Force Deploy: Whether to force deployment even if there are no changes.
• Clear Cache: Whether to clear cache before deployment.
• Commit ID: Specific commit ID to deploy.

Output

The node outputs a JSON array containing the response from the Coolify API related to the deployment creation. This typically includes details about the deployment status, identifiers, timestamps, and any messages returned by the API.

No binary data output is indicated.

Dependencies

  • Requires an active connection to the Coolify API.
  • Needs an API authentication token configured in n8n credentials (referred generically as an API key credential).
  • The node depends on internal helper functions to make HTTP requests to Coolify endpoints.

Troubleshooting

  • Common issues:
    • Invalid or missing Application ID will cause deployment failure.
    • Incorrect or expired API credentials will result in authentication errors.
    • Specifying a non-existent commit ID may cause the deployment to fail or return an error.
  • Error messages:
    • "The resource "deployment" is not implemented!" — indicates a misconfiguration or unsupported resource selection.
    • "The operation "create" is not implemented!" — indicates the selected operation is not available for the resource.
    • Network or API errors should be checked by verifying API endpoint accessibility and credentials.

To resolve these, verify that the Application ID is correct, the API credentials are valid, and the commit ID (if provided) exists in the repository.

Links and References

Discussion