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 Update Plugin From Zip Archive operation, the node uploads a ZIP archive file containing a plugin and re-installs it in the Dataiku DSS instance.

This functionality is useful when you want to update an existing plugin by providing a new version packaged as a ZIP file. It automates the process of uploading and reinstalling plugins without manual intervention in the Dataiku DSS UI.

Practical example:

  • You have developed a new version of a Dataiku DSS plugin locally, packaged it as a ZIP archive, and want to deploy this updated plugin to your DSS instance programmatically via n8n.

Properties

Name Meaning
Plugin ID The unique identifier of the plugin to update. Required to specify which plugin to update.
File The ZIP archive file content (binary) representing the plugin package to upload and install.

Output

The node outputs the response from the Dataiku DSS API after attempting to update the plugin from the ZIP archive. The output is provided in JSON format and typically contains information about the success or failure of the update operation, including any relevant metadata returned by the API.

If the operation involves downloading files (not applicable here), the node can output binary data representing the downloaded file. For this operation, the output is JSON only.

Dependencies

  • Requires valid Dataiku DSS API credentials, including:
    • The URL of the Dataiku DSS server.
    • A user API key for authentication.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API.
  • The node expects the ZIP archive file to be provided as binary data input under the property "File".

Troubleshooting

  • Missing Credentials Error:
    If the node throws an error about missing Dataiku DSS API credentials, ensure that you have configured the required API key credential in n8n before running the node.

  • Required Parameters Missing:
    The node validates the presence of the Plugin ID and the ZIP file. If either is missing, it will throw an error indicating the missing parameter.

  • API Request Failures:
    Errors returned from the Dataiku DSS API are wrapped and reported with messages like "Error calling Dataiku DSS API: ...". Check the API key permissions, plugin ID correctness, and the validity of the ZIP archive.

  • File Upload Issues:
    Ensure the ZIP file is correctly loaded as binary data in n8n and referenced properly in the "File" property.

Links and References


Note: This summary focuses on the "Plugin" resource and the "Update Plugin From Zip Archive" operation as requested. The node supports many other resources and operations not covered here.

Discussion