Coolify icon

Coolify

Interact with Coolify API

Overview

This node integrates with the Coolify API to manage applications and related resources. Specifically, the Application - Create (Docker Compose) operation allows users to create a new application on a specified server and project by providing the content of a Docker Compose file. This is useful for automating deployment workflows where infrastructure is defined as code using Docker Compose.

Typical use cases include:

  • Automating the deployment of multi-container Docker applications.
  • Managing application lifecycle in Coolify via n8n workflows.
  • Quickly spinning up applications on different servers/projects by changing input parameters.

Example: A user can provide a Docker Compose YAML content to deploy a web app stack (e.g., frontend, backend, database) on a selected server and project without manual intervention.

Properties

Name Meaning
Server Name or ID Select the target server from a list or specify its ID where the application will be deployed.
Project Name or ID Select the project under which the application will be created, either from a list or by ID.
Name The name to assign to the new application.
Docker Compose File The full content of the Docker Compose file defining the application's services and configuration.

Output

The node outputs a JSON array containing the response from the Coolify API after creating the application. This typically includes details about the newly created application such as its ID, status, and metadata.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Coolify API via an API key credential configured in n8n.
  • The node depends on the Coolify API endpoints for servers, projects, and application creation.
  • Network access to the Coolify service must be available from the n8n instance.

Troubleshooting

  • Error: Resource or Operation not implemented
    This occurs if an unsupported resource or operation name is provided. Ensure "application" is selected as the resource and "createDockerCompose" as the operation.

  • API Request Failures
    Errors during API calls (e.g., loading servers or projects) may indicate network issues, invalid credentials, or insufficient permissions. Verify API key validity and network connectivity.

  • Invalid Docker Compose Content
    If the Docker Compose file content is malformed or incompatible, the API might reject the request. Validate the YAML syntax and compatibility with Coolify before submission.

  • Missing Required Parameters
    All required fields (server, project, name, compose file) must be provided. Missing any will cause errors.

Links and References

Discussion