Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

The "Get Project" operation of the "Project Deployer" resource in this Dataiku DSS node allows users to retrieve detailed information about a published project deployed via the Project Deployer service. This operation is useful when you want to programmatically access metadata or status details of a deployed project within your automation workflows.

Typical use cases include:

  • Monitoring deployment status and configurations of projects.
  • Integrating project deployment data into dashboards or reports.
  • Automating deployment verification steps in CI/CD pipelines.

For example, you might use this operation to fetch the current state and settings of a deployed project before triggering further automated tests or notifications.

Properties

Name Meaning
Project Key The unique identifier key of the project for which you want to get deployment details.

Note: For this operation, the only required input property is the Project Key.

Output

The output of this operation is a JSON object containing the details of the specified published project as retrieved from the Project Deployer API. The exact structure depends on the API response but typically includes metadata such as project name, deployment status, configuration settings, and other relevant attributes describing the deployed project.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to a Dataiku DSS instance with the appropriate API credentials (an API key credential).
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
  • The Project Deployer service must be accessible on the configured DSS server.

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.
  • Missing Required Parameters: Errors like "Project Key is required" indicate that the mandatory input parameter was not provided. Make sure to specify the Project Key.
  • API Connection Issues: Network or authentication failures can cause request errors. Verify network connectivity and API key validity.
  • Unexpected Response Format: If the output cannot be parsed as JSON, check if the DSS server is returning an error page or unexpected content.

Links and References


This summary focuses specifically on the "Get Project" operation under the "Project Deployer" resource, based on the provided source code and input properties.

Discussion