Coolify icon

Coolify

Interact with Coolify API

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 "Resource" resource with the "Get Many" operation, it retrieves multiple resource entries from Coolify, optionally filtered by type, status, project ID, or a search term.

Common scenarios include:

  • Fetching a list of resources in a project to monitor their statuses.
  • Filtering resources by type (e.g., only applications or databases) to display or process them further.
  • Searching resources by keywords to find specific entries quickly.

Practical example:

  • A user wants to get all running application-type resources within a specific project to generate a report or trigger downstream workflows based on their state.

Properties

Name Meaning
Return All Whether to return all matching results or limit the number of returned items.
Limit Maximum number of results to return if "Return All" is false.
Filters Collection of filters to narrow down the results:
- Type Filter by resource type; options: Application, Database, Service.
- Status Filter by resource status; options: Running, Stopped, Failed.
- Project ID Filter resources belonging to a specific project by its ID.
- Search Search term to filter resources by name or other searchable fields.

Output

The node outputs an array of JSON objects representing the retrieved resources. Each object corresponds to a resource entry matching the specified filters and limits.

The exact structure of each resource object depends on the Coolify API response but typically includes fields like resource ID, name, type, status, project association, and other metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Coolify API via an API key credential configured in n8n.
  • The node uses internal helper functions to make authenticated HTTP requests to Coolify endpoints.
  • No additional external dependencies beyond the Coolify API and n8n's credential system.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using unsupported resource types or operations will throw errors indicating they are not implemented.
    • Providing invalid filter values may result in empty responses or API errors.
  • Error messages:

    • "The resource \"resource\" is not implemented!" — Occurs if the selected resource is not supported by the node.
    • "The operation \"getAll\" is not implemented!" — Happens if the operation is not defined for the chosen resource.
  • Resolutions:

    • Verify that the API key credential is correctly set up and has necessary permissions.
    • Ensure the resource and operation names match those supported by the node.
    • Double-check filter values for correctness and compatibility with the Coolify API.

Links and References

Discussion