Summary

The updateFieldAliasSchema() GraphQL mutation may be used to update an existing schema.

API Stability Long-Term

Syntax

graphql
updateFieldAliasSchema(
      input: UpdateFieldAliasSchemaInput!
   ): FieldAliasSchema!

For the input, you'll have to give the identifier of the schema, the alias mapping and the fields. Use the fieldAliasSchemas() query to find the identifier. See the Input Parameters section for details.

For the results, you can get a list of fields and their descriptions for the schema, and mapping of instances. See the Returned Values section for what's available.

Example

Raw
graphql
mutation {
  updateFieldAliasSchema( input:
     { id: "abc123", 
       aliasMappings: [ 
             { name: "my-alias", 
               tags: [ {name: "#kind", value: "logs"}, 
                       {name: "#repo", value: "github"} ],
               aliases: [ { source: "some", alias: "thing" } ] } ]
     } 
  )
  { 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 {
  updateFieldAliasSchema( input:
     { id: \"abc123\", 
       aliasMappings: [ 
             { name: \"my-alias\", 
               tags: [ {name: \"#kind\", value: \"logs\"}, 
                       {name: \"#repo\", value: \"github\"} ],
               aliases: [ { source: \"some\", alias: \"thing\" } ] } ]
     } 
  )
  { 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 {
  updateFieldAliasSchema( input:
     { id: \"abc123\", 
       aliasMappings: [ 
             { name: \"my-alias\", 
               tags: [ {name: \"#kind\", value: \"logs\"}, 
                       {name: \"#repo\", value: \"github\"} ],
               aliases: [ { source: \"some\", alias: \"thing\" } ] } ]
     } 
  )
  { 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 { ^
  updateFieldAliasSchema( input: ^
     { id: \"abc123\",  ^
       aliasMappings: [  ^
             { name: \"my-alias\",  ^
               tags: [ {name: \"#kind\", value: \"logs\"},  ^
                       {name: \"#repo\", value: \"github\"} ], ^
               aliases: [ { source: \"some\", alias: \"thing\" } ] } ] ^
     }  ^
  ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateFieldAliasSchema( input:
     { id: \"abc123\", 
       aliasMappings: [ 
             { name: \"my-alias\", 
               tags: [ {name: \"#kind\", value: \"logs\"}, 
                       {name: \"#repo\", value: \"github\"} ],
               aliases: [ { source: \"some\", alias: \"thing\" } ] } ]
     } 
  )
  { 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 {
  updateFieldAliasSchema( input:
     { id: \"abc123\", 
       aliasMappings: [ 
             { name: \"my-alias\", 
               tags: [ {name: \"#kind\", value: \"logs\"}, 
                       {name: \"#repo\", value: \"github\"} ],
               aliases: [ { source: \"some\", alias: \"thing\" } ] } ]
     } 
  )
  { 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 {
  updateFieldAliasSchema( input:
     { id: \"abc123\", 
       aliasMappings: [ 
             { name: \"my-alias\", 
               tags: [ {name: \"#kind\", value: \"logs\"}, 
                       {name: \"#repo\", value: \"github\"} ],
               aliases: [ { source: \"some\", alias: \"thing\" } ] } ]
     } 
  )
  { 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 {
  updateFieldAliasSchema( input:
     { id: \"abc123\", 
       aliasMappings: [ 
             { name: \"my-alias\", 
               tags: [ {name: \"#kind\", value: \"logs\"}, 
                       {name: \"#repo\", value: \"github\"} ],
               aliases: [ { source: \"some\", alias: \"thing\" } ] } ]
     } 
  )
  { 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": {
    "updateFieldAliasSchema": {
      "id": "abc123"
    }
  }
}

Input Parameters

For the input, you'll have to give the unique identifier of the schema, the alias mapping and the fields. Use the fieldAliasSchemas() query to find the identifier.

Table: UpdateFieldAliasSchemaInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 23, 2024
aliasMappings[AliasMappingInput]yes Long-TermThe alias mappings on the schema. This overrides the existing alias mappings. If not supplied, the alias mapping will be unchanged. See AliasMappingInput.
fields[SchemaFieldInput]yes Long-TermThe fields of the schema. This overrides the existing fields. If not supplied, the fields will be unchanged. See SchemaFieldInput.
idstringyes Long-TermThe unique identifier of the schema.
namestring  Long-TermThe name of the schema. This will override the existing name. If not supplied, the name will be unchanged.

Returned Values

For the results, you can get 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.

Table: FieldAliasSchema Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for 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.