Sign in

v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Storage/Datasets

Update dataset

Updates a dataset's name and general resource access level using a value specified by a JSON object passed in the PUT payload. The response is the updated dataset object, as returned by the Get dataset API endpoint.

put/v2/datasets/{datasetId}

Path parameters

datasetIdstring required
Example:WkzbQMuFYuamGv3YF

Dataset ID or username~dataset-name.

Request body

namestring nullable
generalAccess'ANYONE_WITH_ID_CAN_READ' | 'ANYONE_WITH_NAME_CAN_READ' | 'FOLLOW_USER_SETTING' | 'RESTRICTED'

Defines the general access level for the resource.

Example request

{
  "name": "new-dataset-name",
  "generalAccess": "RESTRICTED"
}

Response

Example response

{
  "data": {
    "id": "WkzbQMuFYuamGv3YF",
    "name": "d7b9MDYsbtX5L7XAj",
    "userId": "wRsJZtadYvn4mBZmm",
    "createdAt": "2019-12-12T07:34:14.202Z",
    "modifiedAt": "2019-12-13T08:36:13.202Z",
    "accessedAt": "2019-12-14T08:36:13.202Z",
    "itemCount": 7,
    "cleanItemCount": 5,
    "schema": {
      "actorSpecification": 1,
      "title": "My dataset",
      "views": {
        "overview": {
          "title": "Overview",
          "transformation": {
            "fields": [
              "linkUrl"
            ]
          },
          "display": {
            "component": "table",
            "properties": {
              "linkUrl": {
                "label": "Link URL",
                "format": "link"
              }
            }
          }
        }
      }
    },
    "consoleUrl": "https://console.apify.com/storage/datasets/27TmTznX9YPeAYhkC",
    "itemsPublicUrl": "https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123",
    "generalAccess": "RESTRICTED",
    "stats": {
      "readCount": 22,
      "writeCount": 3,
      "storageBytes": 783
    }
  }
}