Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to manage various aspects of their Dataiku DSS projects programmatically within n8n workflows. Specifically, for the API Service resource and the Publish Package operation, it enables publishing an API service package to the API Deployer.

Typical use cases include automating deployment pipelines where after generating or updating an API service package in Dataiku DSS, you want to publish it automatically without manual intervention. This is useful in continuous integration/continuous deployment (CI/CD) scenarios, ensuring that the latest API packages are deployed promptly.

Example: After a successful model training and packaging step in Dataiku DSS, this node can be used to publish the new API package so that it becomes available for consumption by other applications or services.

Properties

Name Meaning
Project Key The unique key identifying the Dataiku DSS project containing the API service.
Service ID The identifier of the API service within the project.
Package ID The identifier of the specific package of the API service to publish.
Query Parameters Optional additional query parameters to customize the publish request.

Output

The node outputs the response from the Dataiku DSS API call in JSON format under the json field. The output typically contains details about the published package or confirmation of the publish action.

If the operation involves downloading files or binary data (not applicable for Publish Package), the node would output binary data accordingly, but for publishing, the output is JSON.

Dependencies

  • Requires valid Dataiku DSS API credentials including:
    • The DSS server URL.
    • A user API key for authentication.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Dataiku DSS API Credentials," ensure that the API key credential is properly configured in n8n.
  • Required Parameter Errors: The node validates required parameters such as Project Key, Service ID, and Package ID. Missing any of these will cause errors like "Project Key is required." Make sure all required fields are filled.
  • HTTP Errors: Errors returned from the Dataiku DSS API (e.g., 4xx or 5xx status codes) will be surfaced as node errors with messages prefixed by "Error calling Dataiku DSS API." Check the API server logs or network connectivity if these occur.
  • Invalid JSON Response: If the API returns non-JSON or unexpected responses, the node attempts to parse them; failure results in raw text output. Verify the API endpoint and parameters.

Links and References


This summary focuses on the API Service resource and the Publish Package operation as requested, based on static analysis of the provided source code and property definitions.

Discussion