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 operations on Dataiku DSS resources. Specifically for the Project Deployer resource and the Delete Project operation, it enables deleting a published project from the Dataiku Project Deployer system.

Common scenarios where this node is beneficial include automating project lifecycle management in Dataiku DSS, such as programmatically removing deployed projects when they are no longer needed or during cleanup processes in CI/CD pipelines.

Example use case:

  • Automatically delete a published project from the Project Deployer after a deployment rollback or when decommissioning an environment.

Properties

Name Meaning
Project Key The unique identifier key of the project to target for the operation (required).

For this specific operation (Delete Project under Project Deployer), only the Project Key property is required and used.

Output

The output of the node is a JSON array containing the response from the Dataiku DSS API call. For the Delete Project operation, the response typically confirms the deletion status or returns an empty success response.

  • The output JSON will contain the API response data.
  • No binary data output is expected for this operation.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials: an API server URL and a user API key credential.
  • The node uses HTTP requests to communicate with the Dataiku DSS REST API.
  • The node expects the "Dataiku DSS API" credentials configured in n8n with the DSS server address and user API key.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node throws an error indicating missing credentials.
  • Required Parameter Missing: The node validates required parameters like Project Key and will throw errors if these are not provided.
  • HTTP Errors: Any HTTP error responses from the Dataiku DSS API will be wrapped and thrown as node errors with descriptive messages.
  • API Endpoint Errors: Ensure the project key exists and the user has permission to delete the project; otherwise, the API may return authorization or not found errors.

Links and References


This summary focuses on the Project Deployer - Delete Project operation extracted from the provided source code and properties.

Discussion