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 various Dataiku DSS resources. Specifically for the Project Deployer resource and the Get Deployment Settings operation, the node retrieves the configuration settings of a specified deployment within the Dataiku Project Deployer system.

This functionality is useful when you want to programmatically access deployment configurations to monitor, audit, or automate deployment management tasks. For example, you might use this node to fetch deployment settings before triggering updates or to verify deployment parameters as part of a CI/CD pipeline.

Properties

Name Meaning
Deployment ID The unique identifier of the deployment whose settings you want to retrieve.

Note: The property is a string input required when performing operations related to deployments, including "Get Deployment Settings".

Output

The node outputs the response from the Dataiku DSS API call corresponding to the requested operation.

  • For the Get Deployment Settings operation under the Project Deployer resource, the output JSON contains the deployment's configuration details as returned by the Dataiku DSS API.
  • The exact structure depends on the API but typically includes fields describing deployment parameters, environment settings, and other relevant metadata.
  • If the operation involves downloading files (not applicable here), the node would output binary data representing the downloaded content.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key credential) for authentication against the Dataiku DSS API.
  • The node expects the base URL of the Dataiku DSS server and the user API key to be configured in the credentials.
  • No additional external dependencies are needed beyond the n8n environment and the provided credentials.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
  • Required Parameter Errors: The node validates required parameters such as Deployment ID for this operation. Missing these will cause errors indicating which parameter is required.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credential correctness.
  • Unexpected Response Format: If the API returns unexpected data or errors, check the Dataiku DSS API documentation and ensure the deployment ID is correct and accessible.
  • Permission Issues: Ensure the API key used has sufficient permissions to access deployment settings.

Links and References


This summary focuses on the Project Deployer resource and the Get Deployment Settings operation as requested, based on static analysis of the provided source code and properties.

Discussion