API Stability Preview

The createFieldAliasSchemaFromTemplate() GraphQL mutation field is used to creates a field aliasing schema from a YAML file. This is a preview and may be changed.

Syntax

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

graphql
createFieldAliasSchemaFromTemplate(
       input: CreateFieldAliasSchemaFromTemplateInput!
    ): FieldAliasSchema!

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

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

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 {
  createFieldAliasSchemaFromTemplate(input:
         {name: \"my-alias\",
          yamlTemplate: \"...\" } )
  { id }
}"
}
);


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 Datatypes

For CreateFieldAliasSchemaFromTemplateInput, there are a few parameters. Below is a list of them:

Table: CreateFieldAliasSchemaFromTemplateInput

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: Oct 8, 2025
namestringyes PreviewThe name of the field alias schema.
yamlTemplatestringyes PreviewThe yaml template to use.

Returned Datatypes

FieldAliasSchema has a few parameters. They're listed and described below:

Table: FieldAliasSchema

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: Mar 26, 2025
fields[SchemaField]yes Long-TermThe schema fields. See SchemaField.
idstringyes Long-TermThe unique identifier of the field alias schema.
instances[AliasMapping]yes Long-TermThe instances used. See AliasMapping.
namestringyes Long-TermThe name of the schema.
versionstringyes Long-TermThe version.
yamlTemplateYAMLyes Long-TermA yaml template. YAML is a scalar.