Vacuum dataset

axiom.vacuumDataset queues removal of field definitions absent from retained data. It does not delete retained events and returns null after Axiom accepts the request.

automations/axiom-vacuum-dataset.automation.ts

import { automation, onHttpRequest } from "automate.ax"
import { axiom } from "automate.ax/axiom"

export default automation("Vacuum dataset", () => {
  onHttpRequest({ scope: "automation" })
  axiom.vacuumDataset({ datasetName: "production" })
})

This operation changes or deletes provider data. Confirm the target before deployment.

Inputs

datasetName is required and accepts the dataset name or ID to vacuum.

Output

Returns null after Axiom queues the vacuum request. A successful response does not mean vacuuming is complete; processing can take several hours.

Permission and failures

The API token needs the dataset-level vacuum|update capability for the target dataset. Axiom can return 429 when too many vacuum requests are in progress. Missing or inaccessible datasets also fail, and the mutation is not retried automatically after an ambiguous provider response.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Inputs

Output

Permission and failures

​Inputs

​Output

​Permission and failures

Inputs

Output

Permission and failures