Directus icon

Directus

Consume Directus API

Overview

This node interacts with the Directus API to update folder resources. It allows users to modify existing folders by specifying the folder's unique ID and providing updated data fields. This is useful in scenarios where you need to rename a folder or change its parent folder to reorganize your file structure within Directus.

For example, you might use this node to:

  • Rename a folder from "Old Projects" to "Archived Projects".
  • Move a folder under a different parent folder to reflect a new organizational hierarchy.

The node supports both structured UI input for update fields and raw JSON input for more complex or custom updates.

Properties

Name Meaning
ID Unique identifier of the folder to update (required).
JSON/RAW Parameters Whether to provide update parameters as key-value pairs via UI (false) or as raw JSON (true).
Body Parameters The raw JSON body parameters for the update when JSON/RAW Parameters is set to true.
Update Fields Collection of fields to update when JSON/RAW Parameters is false. Includes:
- Name New name of the folder. Cannot be null or empty.
- Parent Unique identifier of the parent folder to nest this folder under.

Output

The output is a JSON object representing the updated folder resource as returned by the Directus API. It contains the folder's properties after the update operation.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to a Directus instance via an API key credential.
  • The node uses the Directus REST API endpoint for folders.
  • Proper permissions on the Directus API are required to update folder resources.

Troubleshooting

  • Invalid ID error: Ensure the folder ID provided exists in Directus and is correctly formatted.
  • Validation errors: If updating the folder name, it must not be empty or null.
  • Permission denied: Verify that the API key used has sufficient rights to update folders.
  • Malformed JSON: When using raw JSON parameters, ensure the JSON syntax is correct to avoid parsing errors.
  • Network issues: Confirm connectivity to the Directus API endpoint.

If the node throws errors related to request failures, check the API credentials and network access.

Links and References

Discussion