Create dataset

POST/v2/datasets

Create dataset

Parameters

Property	Type	Location	Description
`referrer`	`string`	`query`	Referrer slug

Body

application/json

Property	Type	Description
`description`	`string`	Dataset description
`edgeDeployment`	`string`	Edge deployment of the dataset
`kind`	`string`	The kind of the dataset
`name`	`string`Required	Dataset unique name
`retentionDays`	`integer`	Number of days to retain data in the dataset
`useRetentionPeriod`	`boolean`	Whether to use the retention period

Request

curl -X POST 'https://api.axiom.co/v2/datasets' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"description":"string","kind":"axiom:events:v1","name":"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 Requiredreferrer queryRequest body application/json

Response

200Created

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
`mapFields`	`string[]`
`name`	`string`Required	Unique dataset name
`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
`who`	`string`Required	Name of the dataset creator