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 Streaming Endpoint resource, it supports updating streaming endpoint settings among other actions like creating, listing, deleting, and managing schemas.

The Update Streaming Endpoint Settings operation allows users to modify the configuration of an existing streaming endpoint within a specified project. This is useful when you need to change how data streams are handled or adjust parameters related to streaming endpoints in your Dataiku DSS projects.

Common scenarios:

  • Adjusting streaming endpoint configurations to optimize data flow.
  • Updating authentication or connection details for a streaming endpoint.
  • Managing streaming endpoints programmatically as part of automated workflows.

Practical example:
You have a streaming endpoint that ingests real-time data into your Dataiku project. You want to update its settings to change buffer sizes or enable/disable certain features without manually accessing the Dataiku UI. Using this node operation, you can automate that update via n8n.


Properties

Name Meaning
Project Key The unique key identifying the Dataiku DSS project where the streaming endpoint exists.
Streaming Endpoint ID The identifier of the streaming endpoint whose settings you want to update.
Request Body A JSON object containing the new settings/configuration to apply to the streaming endpoint.

Output

The node outputs the response from the Dataiku DSS API after performing the update operation. The output is structured as JSON and typically contains the updated streaming endpoint object or confirmation of the update.

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

Example output structure (simplified):

{
  "id": "streaming-endpoint-id",
  "name": "Updated Streaming Endpoint Name",
  "settings": {
    // Updated settings fields here
  },
  "status": "updated"
}

Dependencies

  • Requires an active Dataiku DSS API credential configured in n8n, which includes:
    • The URL or IP address of the Dataiku DSS server.
    • A valid user API key for authentication.
  • The node makes HTTP requests to the Dataiku DSS REST API endpoints.
  • No additional external libraries beyond those bundled with n8n are required.

Troubleshooting

Common issues:

  • Missing credentials: If the API key or server URL is not set, the node will throw an error indicating missing credentials.
  • Invalid or missing parameters: The node validates required parameters such as Project Key and Streaming Endpoint ID. Omitting these will cause errors.
  • API errors: Errors returned by the Dataiku DSS API (e.g., unauthorized, not found) will be surfaced as node errors with descriptive messages.

Error messages and resolutions:

  • "Missing Dataiku DSS API Credentials": Ensure you have configured the API credentials correctly in n8n.
  • "Project Key is required": Provide the project key parameter; it is mandatory for this operation.
  • "Streaming Endpoint ID is required": Provide the streaming endpoint ID parameter.
  • "Error calling Dataiku DSS API: <message>": Check the API key validity, network connectivity, and that the endpoint exists.

Links and References


Summary

This node operation enables updating the settings of a streaming endpoint in a Dataiku DSS project by sending a properly authenticated request with the desired configuration changes. It is ideal for automating management of streaming endpoints within Dataiku DSS environments.

Discussion