DataHub

Update dataset

Updates an existing DataHub dataset's metadata. Only the description field can be updated. The dataset name is immutable and serves as the resource identifier. To rename a dataset, delete it and create a new one. If name is included in the request body, it must match the dataset name in the URL path. A mismatched name will be rejected with a 400 error.

patch/datahub/v1/datasets/{name}

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/datahub/v1/datasets/{name}
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

namestring required

The name of the dataset to update (immutable, used for identification only).

Request body

namestring

Must match the dataset name in the URL path. Included for idempotency; the name cannot be changed.

descriptionstring

The new description for the dataset.

Example request

{
  "name": "My Custom Dataset",
  "description": "Updated description for the dataset"
}

Response

OK - Dataset updated successfully.

namestring

The name of the dataset.

descriptionstring

The description of the dataset.

recordsinteger nullable

The number of records in the dataset.

updatedBystring

The email of the user who last updated the dataset.

lastUpdatedstring

The timestamp of the last update.

Example response

{
  "name": "My Custom Dataset",
  "description": "Updated description for the dataset",
  "records": 1500,
  "updatedBy": "user@example.com",
  "lastUpdated": "2024-03-10T23:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.