Stability Level Long-Term
API Stability Long-Term

The addFileLabels() GraphQL mutation is used to add labels to a file. There can be at most ten labels at a time, with a maximum length of sixty characters per label. It will return the updated file if successful, or null with errors if it fails.

Syntax

Below is the syntax for the addFileLabels() mutation field:

graphql
addFileLabels(
      input: AddFileLabels!
   ): File

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  addFileLabels(
    input: { 
      viewName: "humio",
      fileName: "my-file.txt",
      labels: [ "bobs-files",
                "admin-files" ]
    }
  )
  { createdAt }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addFileLabels(
    input: { 
      viewName: \"humio\",
      fileName: \"my-file.txt\",
      labels: [ \"bobs-files\",
                \"admin-files\" ]
    }
  )
  { createdAt }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addFileLabels(
    input: { 
      viewName: \"humio\",
      fileName: \"my-file.txt\",
      labels: [ \"bobs-files\",
                \"admin-files\" ]
    }
  )
  { createdAt }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  addFileLabels( ^
    input: {  ^
      viewName: \"humio\", ^
      fileName: \"my-file.txt\", ^
      labels: [ \"bobs-files\", ^
                \"admin-files\" ] ^
    } ^
  ) ^
  { createdAt } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addFileLabels(
    input: { 
      viewName: \"humio\",
      fileName: \"my-file.txt\",
      labels: [ \"bobs-files\",
                \"admin-files\" ]
    }
  )
  { createdAt }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  addFileLabels(
    input: { 
      viewName: \"humio\",
      fileName: \"my-file.txt\",
      labels: [ \"bobs-files\",
                \"admin-files\" ]
    }
  )
  { createdAt }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  addFileLabels(
    input: { 
      viewName: \"humio\",
      fileName: \"my-file.txt\",
      labels: [ \"bobs-files\",
                \"admin-files\" ]
    }
  )
  { createdAt }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  addFileLabels(
    input: { 
      viewName: \"humio\",
      fileName: \"my-file.txt\",
      labels: [ \"bobs-files\",
                \"admin-files\" ]
    }
  )
  { createdAt }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "addFileLabels": {
      "createdAt": "1729603406707"
    }
  }
}

Given Datatypes

For the AddFileLabels given datatype, there are a few parameters. Below is a list of them, along with a description of each.

Table: AddFileLabels

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Nov 17, 2025
fileNamestringyes Long-TermThe name of the file.
labels[string]yes Long-TermThe labels for the file. There can be at most ten labels, each with a maximum length of sixty characters.
viewNameRepoOrViewNameyes Long-TermThe name of the view for the file. RepoOrViewName is a scalar.

Returned Datatypes

For File, there are several parameters that may be requested. Below is a list of them:

Table: File

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Jul 24, 2025
allowedActions[AssetAction]yes Short-TermThe allowed asset actions. See AssetAction . This is a preview and may be changed.
contentHashstringyes Long-TermA content hash.
createdAtdatetimeyes Long-TermThe date on which the file was created.
createdBystringyes Long-TermThe author of the file.
fileSizeByteslong  Long-TermThe file size in bytes.
labels[string]yes PreviewThe labels associated with this file.
modifiedAtdatetimeyes Long-TermThe date and time the file was last modified.
modifiedBystringyes Long-TermThe user who last modified the file.
nameAndPathFileNameAndPathyes Long-TermThe name and path of the file. See FileNameAndPath.
packagePackageInstallation  Long-TermThe package, if any, associated with the file. See PackageInstallation.
packageIdVersionedPackageSpecifier  Long-TermThe package identifier. VersionedPackageSpecifier is a scalar.
resourcestringyes Short-TermThe resource identifier for the file.