Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API
Join our community

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Project Deployer resource and the Get Deployment operation, it retrieves detailed information about a specific deployment by its Deployment ID.

Common scenarios where this node is beneficial include:

  • Automating retrieval of deployment details in CI/CD pipelines.
  • Monitoring deployment status programmatically.
  • Integrating deployment data into broader workflows or dashboards.

For example, you can use this node to fetch the current state and metadata of a deployment in your project deployer system, enabling automated checks or reporting.

Properties

Name Meaning
Deployment ID The unique identifier of the deployment to retrieve. This is required to specify which deployment's details to fetch.

Output

The node outputs the response from the Dataiku DSS API corresponding to the requested deployment. The output is structured as JSON and contains all relevant details about the deployment, such as its configuration, status, metadata, and other attributes provided by the API.

If the operation involves downloading files (not applicable for Get Deployment), the node would output binary data representing the downloaded file. However, for the "Get Deployment" operation, the output is purely JSON.

Example output structure (simplified):

{
  "deploymentId": "string",
  "status": "string",
  "createdAt": "timestamp",
  "updatedAt": "timestamp",
  "projectKey": "string",
  "settings": { /* deployment settings object */ },
  // ... other deployment details
}

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Needs an API key credential for authentication with the Dataiku DSS API.
  • The node expects the base URL of the DSS server and the user API key to be configured in the credentials.
  • No additional external dependencies beyond the standard n8n environment and the Dataiku DSS API.

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.
  • Deployment ID Required: The operation requires a Deployment ID; if not provided, the node will throw an error indicating this requirement.
  • HTTP Errors: Network issues, incorrect server URLs, or invalid API keys may cause HTTP errors. Verify the DSS server address and API key validity.
  • Parsing Errors: If the API returns unexpected data, the node might fail to parse the response. Check the API response format and ensure compatibility.
  • Permission Issues: Ensure the API key has sufficient permissions to access deployment information.

Links and References

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

Discussion