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 various Dataiku DSS resources. Specifically for the Project resource and the Push to Git Remote operation, it enables pushing the content of a Dataiku project to a previously-declared Git remote repository. This is useful for version control and collaboration workflows where project changes need to be synchronized with a Git repository.

Common scenarios include:

  • Automating the synchronization of Dataiku projects with Git repositories as part of CI/CD pipelines.
  • Keeping project versions backed up in Git.
  • Collaborating with teams by pushing project updates to shared Git remotes.

Example use case:

  • After making changes to a Dataiku project, use this node to push those changes automatically to the configured Git remote, ensuring that the latest project state is versioned and available to other team members.

Properties

Name Meaning
Project Key The unique identifier key of the Dataiku project to operate on.
Query Parameters Optional additional query parameters to customize the API request.
Remote The name of the Git remote to which the project should be pushed (optional).

Note: The provided properties JSON includes many options, but for the Project - Push to Git Remote operation, the critical input is the Project Key and optionally Remote (as part of query parameters).

Output

The node outputs the response from the Dataiku DSS API call in the json field of the output data. The structure depends on the API response for the push-to-git-remote action, typically including status information about the push operation.

If the operation returns binary data (not typical for this operation), it would be provided in the binary field, but for "Push to Git Remote" the output is expected to be JSON indicating success or failure.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
  • No additional external dependencies beyond the Dataiku DSS API.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
  • Project Key Required: The operation requires a valid project key; if omitted or incorrect, the node will throw an error.
  • Git Remote Not Configured: If the specified Git remote does not exist or is not configured in the Dataiku project, the push operation may fail.
  • API Errors: Any HTTP or API errors returned by the Dataiku DSS server will be surfaced as node errors. Check the error message for details.
  • Network Issues: Ensure network connectivity to the Dataiku DSS server and that the API endpoint is reachable.

Links and References


This summary focuses on the Project resource and the Push to Git Remote operation as requested, based on static analysis of the provided source code and property definitions.

Discussion