AXaxiom
Datasets

Update dataset

Changed on

Updates the description and retentionDays of a dataset. Both values are replaced, so omitting description clears it, and omitting retentionDays or setting it to 0 applies your plan's default retention. labelIds replaces assignments when supplied; [] clears them. Omitted or null labelIds preserves assignments on updates and creates an unlabeled resource on creation. IDs must belong to existing labels in your organization and are validated before saving.

put/datasets/{dataset_id}

Request

Path parameters

dataset_idstring required

Request body

descriptionstring
labelIdsLabelID[]

Existing label IDs; replaces assignments when supplied, clears with [], and preserves them when omitted or null.

retentionDaysinteger

Number of days to retain data in the dataset

useRetentionPeriodboolean

Ignored. Axiom derives this value from retentionDays.

Example request

{
  "description": "string",
  "retentionDays": 30
}

Response

Updated dataset.

canWriteboolean

Whether this dataset has write access

createdstring date-time required

The RFC3339-formatted time when the dataset was created.

createdByAgentboolean

true when the MCP server created this dataset

descriptionstring required

Dataset description

edgeDeploymentstring

Edge deployment of the dataset

edgeDeploymentUrlstring

URL of the edge deployment

idstring required

Dataset ID

kind'otel:metrics:v1' | 'otel:traces:v1' | 'otel:logs:v1' | 'axiom:events:v1' required

The kind of the dataset

labelIdsLabelID[] required

IDs of labels assigned to this dataset.

labelNamesstring[] required

Names of assigned labels, including with exclude=labels; [] when unassigned.

mapFieldsstring[]
namestring required

Unique dataset name

reclaimableFieldsinteger

Number of unused fields a vacuum can reclaim, when the dataset is a vacuum candidate

retentionDaysinteger

Number of days to retain data in the dataset

sharedByOrgstring

ID of the org that shared this resource, if it's shared

updatedAtstring date-time required

The RFC3339-formatted time when the dataset was last updated.

useRetentionPeriodboolean

Whether to use the retention period

vacuumCandidateboolean

Whether the dataset has unused fields that a vacuum can reclaim

whostring required

Name of the dataset creator

Example response

{
  "created": "2022-07-20T02:35:14.137Z",
  "description": "string",
  "id": "string",
  "kind": "axiom:events:v1",
  "name": "string",
  "updatedAt": "2022-07-20T02:35:14.137Z",
  "who": "string"
}

Changes

  • v2e3baf3b85e8dRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • v2fbc1b8430febRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status