Skip to main content
PATCH
/
api
/
v1
/
datasets
/
{dataset_id}
Update Dataset
curl --request PATCH \
  --url https://api.example.com/api/v1/datasets/{dataset_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "artifact_types": [
    {
      "name": "<string>",
      "description": "<string>",
      "color": "#FF0000"
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "artifact_types": [
    {}
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key
string
header
required

Path Parameters

dataset_id
string<uuid>
required

Body

application/json

Request schema for updating a dataset.

name
string | null
Required string length: 1 - 255
description
string | null
artifact_types
ArtifactType · object[] | null

Response

Successful Response

Response schema for a dataset.

id
string<uuid>
required
name
string
required
description
string | null
required
artifact_types
Artifact Types · object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required