CoolifyInstall

Overview

This node interacts with the Coolify API to manage various resources such as applications, databases, deployments, environment variables, private keys, projects, and servers. Specifically, for the Deployment resource with the Get Status operation, it retrieves the current status of a specified deployment by its ID. This is useful in automation workflows where you need to monitor deployment progress or verify deployment states programmatically.

Practical examples include:

• Automatically checking if a deployment has succeeded before triggering subsequent steps.
• Monitoring deployment statuses across multiple projects and alerting on failures.
• Integrating deployment status checks into CI/CD pipelines.

Properties

Output

The node outputs an array of JSON objects representing the deployment status information returned from the Coolify API. Each object contains details about the deployment's current state, which may include fields like status, timestamps, logs, or other metadata related to the deployment process.

If the node supports binary data output (not indicated here), it would typically represent files or artifacts related to the deployment, but this is not applicable for the Get Status operation.

Dependencies

• Requires an active connection to the Coolify API.
• Needs an API authentication token configured in n8n credentials to authorize requests.
• The node depends on internal helper functions to make HTTP requests to the Coolify API endpoints.

Troubleshooting

• Common issues:

  • Invalid or missing Deployment ID will cause the API request to fail.
  • Network connectivity problems can prevent communication with the Coolify API.
  • Insufficient permissions or invalid API credentials will result in authorization errors.

• Error messages:

  • "The resource "deployment" is not implemented!" — indicates a misconfiguration or unsupported resource selection.
  • "The operation "getStatus" is not implemented!" — suggests the operation name might be incorrect or not supported.
  • API errors returned from Coolify (e.g., 404 Not Found if the deployment ID does not exist) should be checked and handled accordingly.

To resolve these issues:

• Verify that the Deployment ID is correct and exists in your Coolify account.
• Ensure your API credentials are valid and have sufficient permissions.
• Check network connectivity and API endpoint availability.

Links and References

• Coolify Official Documentation — for detailed API usage and deployment management.
• n8n Documentation — for general guidance on creating and using custom nodes and credentials.