Delete fields

POST/v2/datasets/{dataset_id}/delete-fields

Queues the deletion of the listed fields from the dataset schema. Deleted values stay in storage but can't be queried, and ingesting a deleted field again recreates it. You can delete fields once every 5 minutes per dataset.

Parameters

Property	Type	Location	Description
`dataset_id`	`string`Required	`path`

Body

application/json

Property	Type	Description
`fields`	`string[]`Required

Request

curl -X POST 'https://api.axiom.co/v2/datasets/DATASET_ID/delete-fields' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"fields":["field1","field2"]}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token Requireddataset_id pathRequiredRequest body application/json

Response

202Field deletion queued.

application/json

400Empty `fields`, a field that isn't in the schema, a system field or map field, a locked schema, or a metrics dataset.

application/json

403Forbidden

404Not Found

429Fields were deleted from this dataset less than 5 minutes ago. Retry after the time in `Retry-After`.

Property	Type	Description
`fields`	`string[]`
`jobId`	`string`