Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API to perform various operations on Dataiku resources. Specifically, for the Workspace resource and the Delete Workspace operation, it allows users to permanently delete a workspace identified by its workspace key.

Common scenarios where this node is beneficial include automating workspace management tasks such as cleanup or decommissioning of unused or obsolete workspaces in Dataiku DSS projects. For example, an automation workflow could delete workspaces that are no longer needed after project completion or archiving.

Properties

Name Meaning
Workspace Key The unique identifier (key) of the workspace to be deleted. This is required for deletion.

Output

The output of the node is a JSON array containing the response from the Dataiku DSS API after attempting to delete the specified workspace. Typically, for a delete operation, the response might be empty or contain status information confirming the deletion.

  • If the deletion is successful, the output will confirm the action.
  • If the API returns data, it will be parsed and returned as JSON.
  • If the API returns binary data (not typical for delete), it would be handled accordingly, but for this operation, only JSON/text responses are expected.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the Dataiku DSS API.
  • The node expects the base URL of the Dataiku DSS server and the user API key credential to be configured in n8n.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not provided or invalid, the node throws an error "Missing Dataiku DSS API Credentials". Ensure that the API key credential is correctly set up in n8n.
  • Required Parameter Missing: If the "Workspace Key" property is not provided, the node will throw an error indicating that the workspace key is required.
  • API Errors: Any errors returned by the Dataiku DSS API during the delete request will be caught and reported with the message prefix "Error calling Dataiku DSS API". Check the API permissions and workspace existence.
  • Network Issues: Connectivity problems to the Dataiku DSS server will cause request failures. Verify network access and server availability.

Links and References


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

Discussion