Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to manage various Dataiku DSS resources programmatically within n8n workflows. Specifically for the Connection resource and the Create Connection operation, it allows creating new connections on a Dataiku DSS instance by sending a JSON request body describing the connection details.

Common scenarios where this node is beneficial include automating the setup of data source connections in Dataiku DSS projects, integrating connection management into CI/CD pipelines, or dynamically creating connections based on external inputs or events.

For example, you might use this node to:

  • Automatically create a new database connection in Dataiku DSS when a new environment is provisioned.
  • Create connections to different data sources as part of a data pipeline orchestration.
  • Manage connections centrally via n8n workflows triggered by external systems.

Properties

Name Meaning
Request Body A JSON object defining the connection details to be created in Dataiku DSS. This should conform to the expected schema of the Dataiku DSS API for connection creation.

The Request Body property is the main input for the "Create Connection" operation. It expects a JSON structure that specifies all necessary parameters for the connection, such as connection type, credentials, configuration settings, etc., as required by the Dataiku DSS API.

Output

The output of this node is a JSON array containing the response from the Dataiku DSS API after attempting to create the connection. The exact structure depends on the API's response but typically includes details about the newly created connection or error information if the creation failed.

If the API returns binary data (not typical for connection creation), it would be provided as binary output, but for this operation, the output is JSON.

Example output snippet (conceptual):

[
  {
    "json": {
      "name": "my_new_connection",
      "type": "jdbc",
      "details": {
        "host": "db.example.com",
        "port": 5432,
        "database": "mydb"
      },
      "status": "created"
    }
  }
]

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API authentication credentials (an API key) configured in n8n for the Dataiku DSS API.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API endpoints.
  • No additional external services are needed beyond the Dataiku DSS server and its API.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials (API key and server URL) are properly set up in n8n.
  • Required Parameters Missing: The node validates required parameters like connection name. If these are missing, it will throw errors indicating which parameter is required.
  • Invalid JSON in Request Body: Ensure the JSON provided in the Request Body property is well-formed and matches the expected schema for a connection in Dataiku DSS.
  • API Errors: If the Dataiku DSS API returns an error (e.g., due to invalid connection details or permissions), the node will throw an error with the message returned by the API. Check the API documentation and your connection details.
  • Network Issues: Connectivity problems between n8n and the Dataiku DSS server can cause failures. Verify network access and firewall rules.

Links and References

This summary focuses on the "Connection" resource and the "Create Connection" operation as requested, based on static analysis of the provided source code and properties.

Discussion