Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on Dataiku DSS resources directly from n8n workflows. Specifically, for the API Service resource and the Delete Package operation, the node allows deleting a specific package of an API service within a given project.

Typical use cases include automating the management of API services in Dataiku DSS projects, such as cleaning up outdated or unused API packages programmatically. For example, after deploying a new version of an API service package, you might want to delete older packages automatically to maintain a clean environment.

Properties

Name Meaning
Project Key The unique key identifying the Dataiku DSS project where the API service resides.
Service ID The identifier of the API service containing the package to be deleted.
Package ID The identifier of the specific package to delete from the API service.

These properties are required to specify which package to delete within which API service and project.

Output

The node outputs a JSON array where each item corresponds to the response from the Dataiku DSS API for the executed operation.

  • For the Delete Package operation, the output JSON typically contains the API response confirming the deletion or relevant status information.
  • If the API returns binary data (not typical for delete operations), it would be provided in the binary field, but this operation does not produce binary output.

Example output JSON snippet after successful deletion might look like:

{
  "status": "success",
  "message": "Package deleted successfully"
}

(Note: Actual response structure depends on the Dataiku DSS API.)

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 standard n8n credential configuration.

Troubleshooting

Common Issues

  • Missing Credentials: The node will throw an error if the Dataiku DSS API credentials are not set or invalid.
  • Missing Required Parameters: Errors occur if any of the required parameters (Project Key, Service ID, or Package ID) are not provided.
  • HTTP Errors: Network issues or incorrect API endpoint usage can cause request failures.

Error Messages

  • "Missing Dataiku DSS API Credentials": Ensure that the API credentials are configured correctly in n8n.
  • "Project Key is required", "Service ID is required", "Package ID is required": Provide these mandatory inputs.
  • "Error calling Dataiku DSS API: <error message>": Indicates an issue during the API call; check network connectivity, API permissions, and parameter correctness.

Resolution Tips

  • Verify all required input fields are filled.
  • Confirm the API key has sufficient permissions to delete packages.
  • Check the DSS server URL is reachable from the n8n instance.
  • Review API documentation for any changes in endpoints or required parameters.

Links and References

This summary focuses on the API Service resource and the Delete Package operation, describing how to configure and use the node to delete an API service package in Dataiku DSS.

Discussion