Skip to main content
POST
/
utils
/
metadata
/
tags
Create or update a catalog tag
curl --request POST \
  --url https://api.example.com/utils/metadata/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Data containing email addresses",
  "fully_qualified_name": "PII.Email",
  "name": "Email",
  "style": {
    "color": "#FF6B6B",
    "icon": "mail"
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "fully_qualified_name": "<string>",
  "version": 123,
  "category_id": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "asset_type": "tag",
  "description": "<string>",
  "owners": [
    {}
  ],
  "style": {
    "color": "<string>",
    "icon": "<string>"
  },
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating a catalog tag.

​
name
string
required

Tag name (e.g., 'Email', 'High')

Required string length: 1 - 255
​
fully_qualified_name
string
required

Two-segment FQN in Category.Tag format (e.g., 'PII.Email')

Required string length: 3 - 512
​
description
string | null

Optional tag description

Maximum string length: 2000
​
style
TagStyle · object

Visual styling (color, icon)

​
owners
Owners · object[] | null

Ownership information

Response

Updated

Full catalog tag representation.

​
id
string
required
​
name
string
required
​
fully_qualified_name
string
required
​
version
integer
required
​
category_id
string
required
​
created_by
string
required
​
updated_by
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
asset_type
string
default:tag
​
description
string | null
​
owners
Owners · object[] | null
​
style
TagStyle · object

Visual styling for a tag.

​
deleted_at
string<date-time> | null