Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to perform a wide range of administrative and operational tasks on a Dataiku DSS instance. It supports many resources and operations, including managing global variables, categories, tags, audit trails, licenses, and general settings under the "DSS Administration" resource.

Specifically for the DSS Administration - Save Variables operation, the node enables saving or updating global variables on the DSS instance. This is useful for automating configuration changes or environment setup in Dataiku DSS without manual intervention.

Common scenarios:

  • Automating the update of global variables used across projects.
  • Managing environment-wide settings programmatically.
  • Integrating variable management into larger workflows that interact with Dataiku DSS.

Example use case:
You want to update a set of global variables in your DSS instance as part of a deployment pipeline. Using this node, you can send the new variables as JSON, and the node will save them via the DSS API.

Properties

Name Meaning
Request Body JSON object containing the variables to save or update in the DSS instance global scope.

The Request Body property expects a JSON object representing the variables dictionary to be saved globally in DSS.

Output

The node outputs the response from the Dataiku DSS API call in the json field of the output data. The structure depends on the API response but typically includes confirmation of the saved variables or any error messages.

If the API returns binary data (not typical for this operation), it would be provided in the binary field, but for saving variables, the output is JSON.

Dependencies

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

Troubleshooting

  • Missing Credentials Error: If the API key or server URL is not configured, the node throws an error indicating missing credentials. Ensure the API key credential is properly set up.
  • Required Parameter Errors: The node validates required parameters such as the request body. Missing these will cause errors.
  • API Errors: If the DSS API returns an error (e.g., invalid JSON, permission denied), the node throws an error with the message from the API. Check the API key permissions and the correctness of the JSON payload.
  • Network Issues: Connectivity problems to the DSS server will result in request failures. Verify network access and server availability.

Links and References


This summary focuses on the "DSS Administration" resource and the "Save Variables" operation as requested.

Discussion