Attributes

Add Labels (POST)

Add custom labels to a file for categorization, organization, and enhanced searchability within the Data Lake. Use this endpoint when you need to tag files for better organization and filtering.

post/v1/fileinfo/files/{fileId}/labels

Request

  • Base URL
    api.tetrascience.com (relative, and the document’s source URL is not known)
  • URL
    api.tetrascience.com/v1/fileinfo/files/{fileId}/labels
  • Auth
    API key in header ts-auth-token and API key in header x-org-slug

Path parameters

fileIdstring uuid required

ID assigned to the file when it was created in the data lake. Type is uuid.

Query parameters

noPropagateboolean

Prevents label operation from triggering pipelines.

Headers

x-org-slugstring required

Request body

namestring required
valuestring required

Response

200

namestring
valuestring

Example response

[
  {
    "name": "<name>",
    "value": "<value>"
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.