Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to interact programmatically with various Dataiku DSS resources and operations. Specifically, for the Streaming Endpoint resource with the List Streaming Endpoints operation, it retrieves a list of streaming endpoints associated with a specified project.

Common scenarios where this node is beneficial include automating the management and monitoring of Dataiku DSS projects, integrating Dataiku DSS data flows into broader workflows, or dynamically retrieving metadata about streaming endpoints for further processing or reporting.

For example, a user might want to automatically fetch all streaming endpoints in a project to monitor their status or to trigger downstream processes based on available streaming data sources.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project from which to list streaming endpoints.

Output

The node outputs an array of JSON objects representing the streaming endpoints retrieved from the Dataiku DSS API for the specified project. Each object corresponds to a streaming endpoint and contains its details as provided by the API.

  • The output is structured as JSON under the json field.
  • No binary data output is involved for this operation.

Example output structure (simplified):

[
  {
    "id": "streaming_endpoint_1",
    "name": "Example Streaming Endpoint",
    "status": "active",
    "createdAt": "2023-01-01T12:00:00Z",
    ...
  },
  {
    "id": "streaming_endpoint_2",
    "name": "Another Streaming Endpoint",
    "status": "inactive",
    "createdAt": "2023-02-15T08:30:00Z",
    ...
  }
]

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires 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.
  • No additional external services are required beyond the Dataiku DSS server.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure that you have configured the required API key credential in n8n and linked it properly to this node.
  • Project Key Required: The operation requires a valid project key. If omitted or incorrect, the node will throw an error indicating the missing project key.
  • API Request Failures: Network issues, incorrect server URL, or invalid API keys can cause request failures. Verify the Dataiku DSS server URL and API key validity.
  • Unexpected Response Format: If the API response cannot be parsed as JSON, check if the Dataiku DSS server is returning errors or unexpected content.
  • Permission Issues: Ensure the API key has sufficient permissions to list streaming endpoints in the specified project.

Links and References

Discussion