Stability Level Long-Term
API Stability Long-Term

The updateParserFromTemplate() GraphQL mutation is used to update a parser from a YAML specification.

Syntax

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

graphql
updateParserFromTemplate(
       input: UpdateParserFromTemplateInput!
    ): Parser!

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

Raw
graphql
mutation {
  updateParserFromTemplate(
    input: { 
        repositoryName: "humio",
        id: "abc123",
        yamlTemplate: "..."
      }
  ) { id, name }
}
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 {
  updateParserFromTemplate(
    input: { 
        repositoryName: \"humio\",
        id: \"abc123\",
        yamlTemplate: \"...\"
      }
  ) { id, name }
}"
}
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 {
  updateParserFromTemplate(
    input: { 
        repositoryName: \"humio\",
        id: \"abc123\",
        yamlTemplate: \"...\"
      }
  ) { id, name }
}"
}
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 { ^
  updateParserFromTemplate( ^
    input: {  ^
        repositoryName: \"humio\", ^
        id: \"abc123\", ^
        yamlTemplate: \"...\" ^
      } ^
  ) { id, name } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateParserFromTemplate(
    input: { 
        repositoryName: \"humio\",
        id: \"abc123\",
        yamlTemplate: \"...\"
      }
  ) { id, name }
}"
}'
    "$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 {
  updateParserFromTemplate(
    input: { 
        repositoryName: \"humio\",
        id: \"abc123\",
        yamlTemplate: \"...\"
      }
  ) { id, name }
}";
$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 {
  updateParserFromTemplate(
    input: { 
        repositoryName: \"humio\",
        id: \"abc123\",
        yamlTemplate: \"...\"
      }
  ) { id, name }
}"
}'''

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 {
  updateParserFromTemplate(
    input: { 
        repositoryName: \"humio\",
        id: \"abc123\",
        yamlTemplate: \"...\"
      }
  ) { id, name }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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": {
    "updateParserFromTemplate": {
      "id": "abc123",
      "name": "my-parser"
    }
  }
}

Given Datatypes

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

Table: UpdateParserFromTemplateInput

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: Sep 23, 2025
idstringyes Long-TermThe unique identifier of the parser.
repositoryNameRepoOrViewNameyes Long-TermThe name of the repository in which to install the parser. RepoOrViewName is a scalar.
yamlTemplateYAMLyes Long-TermThe yaml specification of the parser. YAML is a scalar.

Returned Datatypes

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

Table: Parser

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 22, 2025
createdInfoAssetCommitMetadata  PreviewMetadata related to the creation of the parser. See AssetCommitMetadata.
descriptionstring  Long-TermA description of the parser.
displayNamestringyes Long-TermThe full name of the parser, including package information if part of an application.
fieldsToBeRemovedBeforeParsing[string]yes Long-TermA list of fields that will be removed from the event before it's parsed. These fields will not be included when calculating usage.
fieldsToTag[string]yes Long-TermThe fields that are used as tags.
idstringyes Long-TermThe unique identifier of the parser.
isBuiltInbooleanyes Long-TermTrue if the parser is one of LogScale's built-in parsers.
languageVersionLanguageVersionyes Long-TermThe language version used by the parser. See LanguageVersion.
modifiedInfoAssetCommitMetadata  PreviewMetadata related to the latest modification of the parser. See AssetCommitMetadata.
namestringyes Long-TermThe name of the parser.
packagePackageInstallation  Long-TermThe package associated with the parser, if any. See PackageInstallation.
packageIdVersionedPackageSpecifier  Long-TermThe identifier of the package used, if one. VersionedPackageSpecifier is a scalar.
scriptstringyes Long-TermThe parser script that is executed for every incoming event.
testCases[ParserTestCase]yes Long-TermTest cases that can be used to help verify that the parser works as expected. See ParserTestCase.
yamlTemplateYAMLyes Long-TermA template that can be used to recreate the parser. YAML is a scalar.