Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

The "Save Deployment Settings" operation of the Project Deployer resource in this Dataiku DSS node allows users to save or update the configuration settings of a specific deployment within the Dataiku Project Deployer system. This is useful for managing deployment configurations programmatically, enabling automation and integration workflows that require updating deployment parameters without manual intervention.

Typical scenarios include:

  • Automating deployment configuration updates as part of CI/CD pipelines.
  • Synchronizing deployment settings across environments.
  • Managing deployment lifecycle through API calls within n8n workflows.

For example, you might use this operation to update environment variables, resource allocations, or other deployment-specific settings before triggering a deployment update or restart.

Properties

Name Meaning
Deployment ID The unique identifier of the deployment whose settings are to be saved or updated.
Request Body A JSON object containing the deployment settings to be saved. This includes all relevant configuration details for the deployment.

Output

The output of this operation is the JSON response from the Dataiku DSS API after saving the deployment settings. It typically contains confirmation of the saved settings or the updated deployment object.

If the API returns binary data (not typical for this operation), it would represent downloadable content related to the deployment settings, but this operation primarily deals with JSON data.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the Dataiku DSS API.
  • The node must be configured with these credentials in n8n prior to execution.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing Dataiku DSS API credentials. Ensure the API key credential is correctly configured.
  • Missing Deployment ID: The operation requires a Deployment ID; if omitted, the node throws an error. Provide a valid Deployment ID.
  • Invalid JSON in Request Body: The request body must be valid JSON. Malformed JSON will cause the API call to fail.
  • API Errors: Any errors returned by the Dataiku DSS API (e.g., permission denied, invalid settings) will be surfaced as node errors. Check the error message for details and verify permissions and payload correctness.

Links and References


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

Discussion