Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the "Plugin" resource and the "Delete File From Plugin" operation, it allows users to delete a specified file from a plugin by providing the plugin's ID and the relative path of the file within that plugin.

Common scenarios where this node is beneficial include:

  • Automating plugin maintenance tasks such as cleaning up obsolete or unwanted files.
  • Managing plugin contents programmatically as part of CI/CD pipelines.
  • Integrating plugin file management into larger workflows involving Dataiku DSS projects.

Practical example:

  • A user wants to remove a deprecated configuration file from a plugin after an update. By specifying the plugin ID and the file path, this node can delete the file automatically without manual intervention.

Properties

Name Meaning
Plugin ID The unique identifier of the plugin from which the file will be deleted.
Path The relative path to the file inside the plugin that should be deleted.

Output

The output of this node is a JSON array containing the response from the Dataiku DSS API after attempting the deletion. Typically, for a successful delete operation, the API returns confirmation or status information in JSON format.

If the operation involves downloading files (not applicable here), binary data would be returned; however, for deleting a file from a plugin, the output is purely JSON indicating success or failure.

Example output JSON structure (simplified):

[
  {
    "json": {
      "status": "success",
      "message": "File deleted successfully"
    }
  }
]

Dependencies

  • Requires valid Dataiku DSS API credentials including the server URL and an API key.
  • The node expects these credentials to be configured in n8n prior to execution.
  • The node makes HTTP requests to the Dataiku DSS REST API endpoints.
  • No additional external libraries beyond those bundled with n8n are required.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing Dataiku DSS API credentials, ensure that the API key and server URL are correctly set up in n8n credentials.
  • Required Parameters Missing: Errors like "Plugin ID is required" or "Path is required" indicate that mandatory input properties were not provided. Double-check that these fields are filled.
  • HTTP Errors: If the API call fails due to network issues or invalid permissions, verify that the API key has sufficient rights to modify plugins and that the server URL is reachable.
  • File Not Found: If the specified file path does not exist in the plugin, the API may return an error. Confirm the exact relative path of the file within the plugin.
  • Permission Denied: Ensure the API key used has the necessary permissions to delete files from plugins.

Links and References

Discussion