API Stability Long-Term

The createParserFromPackageTemplate() GraphQL mutation field may be used to create a parser from a package parser template.

For more information on creating a parser, see the Create a Parser documentation page. You may also want to look at the Parse Data and Package Management pages for related information.

Syntax

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

graphql
createParserFromPackageTemplate(
      viewName: string!
      packageId: VersionedPackageSpecifier!
      parserTemplateName: string!
      overrideName: string
   ): CreateParserFromPackageTemplateMutation!

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

Raw
graphql
mutation {
  createParserFromPackageTemplate(
        viewName: "humio",
        packageId: "humio/insights@0.0.14",
        parserTemplateName: "humio",
        overrideName: "my-basic-parser"
      )
  { parser { id, fieldsToTag } }
}
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 {
  createParserFromPackageTemplate(
        viewName: \"humio\",
        packageId: \"humio/insights@0.0.14\",
        parserTemplateName: \"humio\",
        overrideName: \"my-basic-parser\"
      )
  { parser { id, fieldsToTag } }
}"
}
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 {
  createParserFromPackageTemplate(
        viewName: \"humio\",
        packageId: \"humio/insights@0.0.14\",
        parserTemplateName: \"humio\",
        overrideName: \"my-basic-parser\"
      )
  { parser { id, fieldsToTag } }
}"
}
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 { ^
  createParserFromPackageTemplate( ^
        viewName: \"humio\", ^
        packageId: \"humio/insights@0.0.14\", ^
        parserTemplateName: \"humio\", ^
        overrideName: \"my-basic-parser\" ^
      ) ^
  { parser { id, fieldsToTag } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createParserFromPackageTemplate(
        viewName: \"humio\",
        packageId: \"humio/insights@0.0.14\",
        parserTemplateName: \"humio\",
        overrideName: \"my-basic-parser\"
      )
  { parser { id, fieldsToTag } }
}"
}'
    "$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 {
  createParserFromPackageTemplate(
        viewName: \"humio\",
        packageId: \"humio/insights@0.0.14\",
        parserTemplateName: \"humio\",
        overrideName: \"my-basic-parser\"
      )
  { parser { id, fieldsToTag } }
}";
$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 {
  createParserFromPackageTemplate(
        viewName: \"humio\",
        packageId: \"humio/insights@0.0.14\",
        parserTemplateName: \"humio\",
        overrideName: \"my-basic-parser\"
      )
  { parser { id, fieldsToTag } }
}"
}'''

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 {
  createParserFromPackageTemplate(
        viewName: \"humio\",
        packageId: \"humio/insights@0.0.14\",
        parserTemplateName: \"humio\",
        overrideName: \"my-basic-parser\"
      )
  { parser { id, fieldsToTag } }
}"
}
);


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 and Returned Datatypes

The given datatype VersionedPackageSpecifier is a scalar value. The returned datatype CreateParserFromPackageTemplateMutation has one parameter with several sub-parameters. Click on the link in the table below to see the sub-parameters:

Table: CreateParserFromPackageTemplateMutation

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: Sep 24, 2024
parserParseryes Long-TermThe parser to create from the package template. See Parser.