API Stability Long-Term

The createFieldAliasSchema() GraphQL mutation may be used to create a schema. If another schema already exists with the same name, this will overwrite it.

Similar to this mutation, you can use the createFieldAliasSchemaFromTemplate() mutation to create a field alias schema from a YAML template. Related to both of these mutations, you can use the updateFieldAliasSchema() to update a field alias schema. You can use deleteFieldAliasSchema() to delete one. Use the fieldAliasSchemaOnView() query to get the active schema and its field aliases of a view. Use fieldAliasSchemas() to retrieve all schemas for any field aliases.

There are also several mutations related to enabling and disabling a field alias schema: use enableFieldAliasSchemaOnViews(), disableFieldAliasSchemaOnView(), and disableFieldAliasSchemaOnView() to enable and disable schema for views; use enableFieldAliasSchemaOnOrg() and disableFieldAliasSchemaOnOrg() for organization schema.

Syntax

graphql
createFieldAliasSchema(
      input: CreateFieldAliasSchemaInput!
   ): FieldAliasSchema!

Example

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

Raw
graphql
mutation {
  createFieldAliasSchema(input:
      { name: "my-scheme",
        fields: [{name: "host"}],
        aliasMappings: [{name:"test", tags: [{name: "#kind", value: "#make"}],
                        aliases: [{source: "something", alias: "other"}]} ]
      } )
  { 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 {
  createFieldAliasSchema(input:
      { name: \"my-scheme\",
        fields: [{name: \"host\"}],
        aliasMappings: [{name:\"test\", tags: [{name: \"#kind\", value: \"#make\"}],
                        aliases: [{source: \"something\", alias: \"other\"}]} ]
      } )
  { 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 {
  createFieldAliasSchema(input:
      { name: \"my-scheme\",
        fields: [{name: \"host\"}],
        aliasMappings: [{name:\"test\", tags: [{name: \"#kind\", value: \"#make\"}],
                        aliases: [{source: \"something\", alias: \"other\"}]} ]
      } )
  { 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 { ^
  createFieldAliasSchema(input: ^
      { name: \"my-scheme\", ^
        fields: [{name: \"host\"}], ^
        aliasMappings: [{name:\"test\", tags: [{name: \"#kind\", value: \"#make\"}], ^
                        aliases: [{source: \"something\", alias: \"other\"}]} ] ^
      } ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createFieldAliasSchema(input:
      { name: \"my-scheme\",
        fields: [{name: \"host\"}],
        aliasMappings: [{name:\"test\", tags: [{name: \"#kind\", value: \"#make\"}],
                        aliases: [{source: \"something\", alias: \"other\"}]} ]
      } )
  { 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 {
  createFieldAliasSchema(input:
      { name: \"my-scheme\",
        fields: [{name: \"host\"}],
        aliasMappings: [{name:\"test\", tags: [{name: \"#kind\", value: \"#make\"}],
                        aliases: [{source: \"something\", alias: \"other\"}]} ]
      } )
  { 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 {
  createFieldAliasSchema(input:
      { name: \"my-scheme\",
        fields: [{name: \"host\"}],
        aliasMappings: [{name:\"test\", tags: [{name: \"#kind\", value: \"#make\"}],
                        aliases: [{source: \"something\", alias: \"other\"}]} ]
      } )
  { 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 {
  createFieldAliasSchema(input:
      { name: \"my-scheme\",
        fields: [{name: \"host\"}],
        aliasMappings: [{name:\"test\", tags: [{name: \"#kind\", value: \"#make\"}],
                        aliases: [{source: \"something\", alias: \"other\"}]} ]
      } )
  { 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();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "createFieldAliasSchema": {
      "id": "fBqzhOMaMwSIbNTY3oXz0vnaULtpRviy"
    }
  }
}

Given Datatype

For this input datatype, you would provide a list of fields and their aliases. These are listed and explained, along with links to other parameters, in the table below:

Table: CreateFieldAliasSchemaInput

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 17, 2024
aliasMappings[AliasMappingInput]yes Long-TermThe alias mapping inputs. See AliasMappingInput.
fields[SchemaFieldInput]yes Long-TermThe schema field inputs. See SchemaFieldInput.
namestringyes Long-TermThe name of the field alias schema.

Returned Datatype

The returned datatype is used to request a schema's unique identifier and name. You can also request a list of fields and their descriptions for the schema, and mapping of instances. The table below lists and describes these and others, as well as provides links to sub-parameters for more details.

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.