Apify icon

Apify

Apify API

Overview

This node interacts with the Apify API to delete a specified dataset. It is useful in scenarios where you need to programmatically remove datasets from your Apify account, such as cleaning up old or unused data collections. For example, you might use this node in an automation workflow to delete datasets after processing their data to maintain storage hygiene.

Use Case Examples

  1. Deleting a dataset by specifying its Dataset ID or the combination of username and dataset name.
  2. Automating dataset cleanup in a data pipeline after data extraction and processing.

Properties

Name Meaning
Dataset Id The unique identifier of the dataset to delete, which can be either the dataset ID or a string in the format 'username~dataset-name'.
Use Custom Body A boolean flag indicating whether to use a custom request body for the API call, though typically not required for deletion.

Output

JSON

  • success - Indicates whether the dataset deletion was successful.
  • deletedDatasetId - The ID of the dataset that was deleted.

Dependencies

  • Requires an Apify API key credential to authenticate requests to the Apify API.

Troubleshooting

  • Ensure the Dataset Id is correctly specified; an incorrect or non-existent ID will cause the deletion to fail.
  • Verify that the Apify API credentials are valid and have the necessary permissions to delete datasets.
  • If using the custom body option, ensure the body format matches the API requirements to avoid request errors.

Links

  • Apify API - Delete Dataset - Official Apify API documentation for deleting datasets, detailing required parameters and response structure.

Discussion