Skip to main content
POST
/
api
/
v1
/
tags
POST tags instances
curl --request POST \
  --url https://app.onecodex.com/api/v1/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "sample": {
    "__DOLLAR_REF__": "/api/v1/samples/a1b2c3d4e5f67890"
  }
}
'
import requests

url = "https://app.onecodex.com/api/v1/tags"

payload = {
"name": "<string>",
"sample": { "__DOLLAR_REF__": "/api/v1/samples/a1b2c3d4e5f67890" }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', sample: {__DOLLAR_REF__: '/api/v1/samples/a1b2c3d4e5f67890'}})
};

fetch('https://app.onecodex.com/api/v1/tags', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.onecodex.com/api/v1/tags",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'sample' => [
'__DOLLAR_REF__' => '/api/v1/samples/a1b2c3d4e5f67890'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://app.onecodex.com/api/v1/tags"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"sample\": {\n \"__DOLLAR_REF__\": \"/api/v1/samples/a1b2c3d4e5f67890\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://app.onecodex.com/api/v1/tags")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"sample\": {\n \"__DOLLAR_REF__\": \"/api/v1/samples/a1b2c3d4e5f67890\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.onecodex.com/api/v1/tags")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"sample\": {\n \"__DOLLAR_REF__\": \"/api/v1/samples/a1b2c3d4e5f67890\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "$uri": "/api/v1/tags/0d77065796f8d173",
  "name": "<string>"
}
Create a new Tag and attach it to a sample. Samples can have multiple tags, and samples can be queried by tag — see Retrieve All Samples.

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
required

The tag label or name. Name must be 30 characters or fewer.

Maximum string length: 30
sample
object
required

The sample to tag.

Response

200 - application/json

OK

$uri
string
required
read-only
Pattern: ^/api/v1/tags/[a-f0-9]{16}$
Example:

"/api/v1/tags/0d77065796f8d173"

name
string
required

The tag label or name. Name must be 30 characters or fewer.

Maximum string length: 30