Add tags to a file

files/{file_id}/tags

This call allows you to tag files on the Platform. You can tag your files with keywords to make it easier to identify and organize files you’ve imported from public datasets or copied between projects. Learn more about tagging your files.

In addition to tagging your files, you can do the following via the API:

• Edit previously added tags
• View tags you've set on your files
• Filter by tags

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/{file_id}/tags

Request

Example request

HTTP

PUT v2/files/567890abc9b0307bc0414164/tags HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
Content-Type: application/json

cURL

curl --data '{"tags": ["test 1b", "my first project", "CCLE"}'  -s -H "X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96" -H "content-type: application/json" -X POST "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/567890abc9b0307bc0414164/tag"

Header Fields

Name	Description
X-SBG-Auth-Token required	Your Platform authentication token authentication token
Content-Type required	application/json

Request body

In the body, you should enter a list of key-value pairs. The keys and the values they take are described in the following table.

Key	Datatype of value	Description of value
tags required	String	Keywords which help you identify your files at a glance.

Example request body

JSON

["test 1b","my first project","CCLE"]

RESPONSE

See a list of response codes that may be contained in the body of the response.

Example response body

JSON

[
    "test 1b",
    "my first project",
    "CCLE"
]