Skip to main content
Version: current

Tag

Use the Catalog API to create, update, and retrieve tags.

Tag Object
{
  "tags": [
    "NYC",
    "taxi",
    "2023"
  ],
  "version": "VJ3ijXH4m6k="
}

Tag Attributes​

{{< api-section file="data/software-api/tag.json" data="tagAttributes" >}}

Creating Tags​

Create one or more tags for the specified dataset.

Method and URL
POST /api/v3/catalog/{dataset-id}/collaboration/tag

Parameters​

{{< api-section file="data/software-api/tag.json" data="createTagParameters" >}}


Example Request
curl -X POST 'https://{hostname}/api/v3/catalog/1bcab7b3-ee82-44c1-abcc-e86d56078d4d/collaboration/tag' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tags": ["NYC", "taxi", "2023"]
}'
Example Response
{
  "tags": [
    "NYC",
    "taxi",
    "2023"
  ],
  "version": "VM3ijXH4m6k="
}

Response Status Codes​

{{< api-responses file="data/software-api/tag.json" data="createTagResponseCodes" >}}

Retrieving Tags​

Retrieve the tags applied to the specified dataset.

Method and URL
GET /api/v3/catalog/{dataset-id}/collaboration/tag

Parameters​

{{< api-section file="data/software-api/tag.json" data="retrieveTagParameters" >}}


Example Request
curl -X GET 'https://{hostname}/api/v3/catalog/1bcab7b3-ee82-44c1-abcc-e86d56078d4d/collaboration/tag' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'
Example Response
{
  "tags": [
    "NYC",
    "taxi",
    "2023"
  ],
  "version": "VM3ijXH4m6k="
}

Response Status Codes​

{{< api-responses file="data/software-api/tag.json" data="retrieveTagResponseCodes" >}}

Updating Tags​

Update the tags for the specified dataset.

Method and URL
POST /api/v3/catalog/{dataset-id}/collaboration/tag

Parameters​

{{< api-section file="data/software-api/tag.json" data="updateTagParameters" >}}


Example Request
curl -X POST 'https://{hostname}/api/v3/catalog/1bcab7b3-ee82-44c1-abcc-e86d56078d4d/collaboration/tag' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tags": ["NYC", "taxi", "2023", "archived"],
  "version": "VM3ijXH4m6k="
}'
Example Response
{
  "tags": [
    "NYC",
    "taxi",
    "2023",
    "archived"
  ],
  "version": "yiZSE++9wiU="
}

Response Status Codes​

{{< api-responses file="data/software-api/tag.json" data="updateTagResponseCodes" >}}

Deleting Tags​

Delete the tags for the specified dataset.

note:

Deleting tags means sending an empty array to replace the existing tags with no tags. The tag object will still exist, but it will contain an empty tags array and no tags will appear for the dataset in the Dremio UI.

Method and URL
POST /api/v3/catalog/{dataset-id}/collaboration/tag

Parameters​

{{< api-section file="data/software-api/tag.json" data="deleteTagParameters" >}}


Example Request
curl -X DELETE 'https://{hostname}/api/v3/catalog/1bcab7b3-ee82-44c1-abcc-e86d56078d4d/collaboration/tag' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tags": [],
  "version": "yiZSE++9wiU="
}'
Example Response
{
  "tags": [],
  "version": "wuTAKuRcVas="
}

Response Status Codes​

{{< api-responses file="data/software-api/tag.json" data="deleteTagResponseCodes" >}}