Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to perform a wide range of operations on Dataiku DSS resources programmatically within n8n workflows. Specifically for the Project resource and the Export Project operation, it enables exporting an entire project configuration along with its associated data optionally.

Typical use cases include:

  • Automating backups of Dataiku projects by exporting them regularly.
  • Migrating projects between different Dataiku DSS instances.
  • Archiving project states before major changes or deployments.

For example, a user can configure this node to export a project identified by its key, optionally including datasets, saved models, and other components, then store the exported archive for safekeeping or further processing.

Properties

Name Meaning
Project Key The unique identifier (key) of the Dataiku DSS project to export.

Note: The provided properties JSON shows only "Project Key" as input relevant to the Export Project operation.

Output

The node outputs the response from the Dataiku DSS API call related to the export operation. This typically includes:

  • For export operations, the output is likely a binary file representing the exported project archive (e.g., a ZIP file).
  • The binary data is available in the binary.data field of the output item, prepared for downstream nodes that handle files.
  • If the API returns JSON metadata or status messages instead, these are returned in the json field.

Thus, the output structure is either:

  • A binary object containing the exported project archive file.
  • Or a JSON object with API response details if no binary content is returned.

Dependencies

  • Requires valid credentials for the Dataiku DSS API, specifically an API key credential with access rights to the target project.
  • The node expects the Dataiku DSS server URL and API key to be configured in the credentials.
  • No additional external dependencies beyond the standard n8n environment and the Dataiku DSS API.

Troubleshooting

  • Missing Credentials Error: If the API key credential is not set or invalid, the node will throw an error indicating missing credentials.
  • Required Parameter Errors: The node validates required parameters such as the project key; missing these will cause errors specifying which parameter is missing.
  • API Request Failures: Network issues, incorrect server URLs, or insufficient permissions may cause API request failures. The node surfaces these errors with descriptive messages.
  • Binary Data Handling: When exporting large projects, ensure sufficient memory and storage are available in n8n to handle the binary data payload.

Links and References


This summary focuses on the "Project" resource and "Export Project" operation as requested, based on static analysis of the provided source code and property definitions.

Discussion