Skip to main content

Update Dataset

Route

/v2/datasets/{id}

Description

Update an existing dataset with the provided configuration. The 'If-Match' header with the resource version can be optionally specified for concurrency control.

Method

PUT

Inputs

ParameterTypeRequiredDescription
idstringYesThe unique identifier of the dataset to update
namestringNoHuman-readable name of the dataset
descriptionstringNoDetailed description of the dataset's purpose
sensitivitystringYesSensitivity level (unrestricted, low, moderate, high, critical)
domainstringNoDomain category (corporate, partner, personal, public)
queryobjectNoQuery conditions that define dataset membership
backfills_enabledbooleanNoWhether historical data processing is enabled
policy_idsarray[string]NoList of policy IDs associated with this dataset

Headers

HeaderTypeRequiredDescription
If-MatchstringNoResource version for concurrency control

Request Body

{
"name": "Updated Dataset Name",
"description": "Updated description",
"sensitivity": "high",
"domain": "corporate",
"backfills_enabled": false,
"policy_ids": ["policy-123"]
}

Output

FieldTypeDescription
typestringAlways "datasets"
sizeintegerNumber of datasets returned (always 1)
resourcesarray[Dataset]Array containing the updated dataset
errorsarray[Error]Any errors encountered

Rate Limit

  • 60 requests per minute per API key
  • 5 concurrent requests per endpoint

Example Response

{
"type": "datasets",
"size": 1,
"resources": [
{
"id": "dataset-123",
"version": "v1.2.4",
"name": "Updated Dataset Name",
"description": "Updated description",
"sensitivity": "high",
"domain": "corporate",
"created_at": "2024-01-15T10:30:00Z",
"last_modified": "2024-01-25T16:45:00Z",
"backfills_enabled": false,
"policy_ids": ["policy-123"]
}
],
"errors": []
}