API Stability Long-Term

The generateParserFromTemplate() GraphQL query is used to generate an unsaved parser from a YAML template.

You can use this query field only to get what you need to create a new parse. You'll then have to use the createParserV2() mutation field.

Syntax

graphql
generateParserFromTemplate(
    input: GenerateParserFromTemplateInput!
  ): UnsavedParser

For the input, you'll have to provide the yaml template from which you want to extract a parser. For the results, you can request whatever you need to create a new parser (e.g., the script to execute). See the Return Datatype section for more possibilities.

Example

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

Raw
graphql
query {
  generateParserFromTemplate(
    input: {yamlTemplate: "favorite-yaml-template"}
  ) {
    name, 
    script,
    fieldsToBeRemovedBeforeParsing
  }
}
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" : "query {
  generateParserFromTemplate(
    input: {yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    script,
    fieldsToBeRemovedBeforeParsing
  }
}"
}
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" : "query {
  generateParserFromTemplate(
    input: {yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    script,
    fieldsToBeRemovedBeforeParsing
  }
}"
}
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" : "query { ^
  generateParserFromTemplate( ^
    input: {yamlTemplate: \"favorite-yaml-template\"} ^
  ) { ^
    name,  ^
    script, ^
    fieldsToBeRemovedBeforeParsing ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  generateParserFromTemplate(
    input: {yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    script,
    fieldsToBeRemovedBeforeParsing
  }
}"
}'
    "$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 = "query {
  generateParserFromTemplate(
    input: {yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    script,
    fieldsToBeRemovedBeforeParsing
  }
}";
$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" : "query {
  generateParserFromTemplate(
    input: {yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    script,
    fieldsToBeRemovedBeforeParsing
  }
}"
}'''

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" : "query {
  generateParserFromTemplate(
    input: {yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    script,
    fieldsToBeRemovedBeforeParsing
  }
}"
}
);


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();

Given Datatype

For the input, you'll have to provide the yaml template from which you want to extract a parser.

Table: GenerateParserFromTemplateInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Aug 22, 2025
yamlTemplateYAMLyes Long-TermThe yaml specification of the parser. YAML is a scalar.

Returned Datatype

For the results, you can request from the yaml template what you need to create a new parser. For instance, you could retrieve the script to execute for each event. You can also get a list of any fields that should be removed before parsing. See the table below for details:

Table: UnsavedParser

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Apr 2, 2025
descriptionstring  Long-TermA description of the parser.
fieldsToBeRemovedBeforeParsing[string]yes Long-TermA list of fields that will be removed from the event before it's parsed. These fields aren't included om usage calculation.
fieldsToTag[string]yes Long-TermA list of fields that are used as tags.
namestringyes Long-TermThe name of the unsaved parser.
scriptstringyes Long-TermThe parser script that is executed for each incoming event.
testCases[ParserTestCase]yes Long-TermTest cases that can be used to help verify that the parser works as expected. See ParserTestCase.