Coolify icon

Coolify

Interact with Coolify API
Join our community

Actions36

Overview

This node integrates with the Coolify API to perform various operations on different resources managed by Coolify. Specifically, for the "Resource" resource and the "Get" operation, it retrieves details of a specific resource identified by its ID. This is useful when you want to fetch information about a particular resource within your Coolify environment, such as configuration or status data.

Practical examples include:

  • Fetching details of a deployment resource to monitor its state.
  • Retrieving metadata about a project resource for reporting or automation.
  • Accessing specific resource configurations before performing updates or deletions.

Properties

Name Meaning
ID The unique identifier of the resource to retrieve. This is required to specify which resource's details should be fetched.

Output

The node outputs an array of JSON objects representing the retrieved resource(s). Each object contains the properties and data fields returned by the Coolify API for that resource. The exact structure depends on the resource type but generally includes identifiers, names, statuses, and configuration details.

If the node supports binary data output (not indicated here), it would typically represent files or attachments related to the resource, but this operation focuses on JSON data retrieval.

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 being accessible and responsive.
  • No additional external services are needed beyond the Coolify API.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent resource ID will likely result in an error or empty response.
    • Network connectivity problems can cause request failures.
    • Missing or incorrect API credentials will prevent successful API calls.

  • Error messages:

    • "The resource \"resource\" is not implemented!" indicates the specified resource type is unsupported by the node.
    • "The operation \"get\" is not implemented!" means the requested operation is not available for the resource.
    • API errors from Coolify (e.g., 404 Not Found) usually mean the resource ID does not exist; verify the ID.

  • Resolutions:

    • Double-check the resource ID input for correctness.
    • Ensure the API key credential is valid and has sufficient permissions.
    • Verify network access to the Coolify API endpoint.

Links and References

Discussion