Update dataset

PUT/v2/datasets/{dataset_id}

Update dataset

Parameters

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

Body

application/json

Property	Type	Description
`description`	`string`
`retentionDays`	`integer`	Number of days to retain data in the dataset
`useRetentionPeriod`	`boolean`	Whether to use the retention period

Request

curl -X PUT 'https://api.axiom.co/v2/datasets/DATASET_ID' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"description":"string","retentionDays":30}'

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

200Dataset

application/json

403Forbidden

Property	Type	Description
`canWrite`	`boolean`	Whether this dataset has write access
`created`	`string<date-time>`Required	The RFC3339-formatted time when the dataset was created.
`description`	`string`Required	Dataset description
`edgeDeployment`	`string`	Edge deployment of the dataset
`edgeDeploymentUrl`	`string`	URL of the edge deployment
`id`	`string`Required	Dataset ID
`kind`	`string`Required	The kind of the dataset
`labelIds`	`string[]`Required	IDs of labels assigned to this dataset.
`labels`	`object[]`	Resolved labels assigned to this dataset.
`color`	`object`Required
`name`	`string`Required
`type`	`string`Required
`description`	`string`
`id`	`string`Required
`name`	`string`Required
`mapFields`	`string[]`
`name`	`string`Required	Unique dataset name
`reclaimableFields`	`integer<int64>`	Number of unused fields a vacuum can reclaim, when the dataset is a vacuum candidate
`retentionDays`	`integer`	Number of days to retain data in the dataset
`sharedByOrg`	`string`	ID of the org that shared this resource, if it's shared
`updatedAt`	`string<date-time>`Required	The RFC3339-formatted time when the dataset was last updated.
`useRetentionPeriod`	`boolean`	Whether to use the retention period
`vacuumCandidate`	`boolean`	Whether the dataset has unused fields that a vacuum can reclaim
`who`	`string`Required	Name of the dataset creator