createParserFromPackageTemplate()

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 Creating a Parser documentation page. You may also want to look at the Parsing Data and Packages 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:

Show:

graphql

mutation {
  createParserFromPackageTemplate(
        viewName: "humio",
        packageId: "humio/insights@0.0.14",
        parserTemplateName: "humio",
        overrideName: "my-basic-parser"
      )
  { parser { id, fieldsToTag } }
}

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

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

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 } } ^
}" ^
} '

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

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

#! /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)

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

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: TECreateParserFromPackageTemplateMutationXT

Parameter	Type	Required	Stability	Description
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 24, 2024
`parser`	`parser`	yes	`Long-Term`	The parser to create from the package template. See `parser`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes