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 List Git Branches operation, it retrieves information about the git branches associated with a specified plugin.

Common scenarios where this node is beneficial include:

  • Managing plugins in Dataiku DSS by querying their git branches.
  • Automating workflows that require synchronization or inspection of plugin source control states.
  • Integrating plugin version control status into broader data pipeline automation.

Practical example:

  • You have a plugin under development in Dataiku DSS and want to list all its git branches to decide which branch to deploy or update.

Properties

Name Meaning
Plugin ID The unique identifier of the plugin for which to list git branches.

Output

The output contains a JSON array representing the git branches of the specified plugin. Each item in the array provides details about a git branch related to the plugin.

If the operation involves downloading files (not applicable here), binary data would be returned accordingly, but for listing git branches, the output is purely JSON.

Example output structure (conceptual):

[
  {
    "branchName": "main",
    "commitHash": "abc123def456...",
    "isCurrent": true,
    ...
  },
  {
    "branchName": "feature-xyz",
    "commitHash": "789ghi012jkl...",
    "isCurrent": false,
    ...
  }
]

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs valid API credentials (an API key credential) for authentication against the Dataiku DSS API.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure you have configured the required API key credential in n8n.
  • Plugin ID Required: For the List Git Branches operation, the Plugin ID must be provided; otherwise, the node will throw an error indicating this requirement.
  • Network Issues: Connectivity problems to the Dataiku DSS server will cause request failures. Verify network access and server URL correctness.
  • API Errors: If the API returns errors (e.g., unauthorized, not found), check that the API key has sufficient permissions and that the Plugin ID exists.
  • Unexpected Response Format: If the response cannot be parsed as JSON, verify the Dataiku DSS server version compatibility and API stability.

Links and References

Discussion