addFieldAliasMapping()

API Stability	`Long-Term`

The addFieldAliasMapping() GraphQL mutation can be used to add a field alias mapping to an existing schema. It returns the unique identifier of the alias mapping — if successful.

For more information on dashboards, see the Dashboards & Widgets documentation page.

Syntax

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

graphql

addFieldAliasMapping(
      input: AddAliasMappingInput!
    ): string!

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

Show:

graphql

mutation {
  addFieldAliasMapping(
      schemaId: "123", 
      aliasMapping: {
        name: "ECS for HAProxy", 
        tags: [ {name: "kind", value: "logs"}, 
                {name: "repo", value: "github"} ],
        aliases: [ {source: "port", alias: "source.port"} ]
      } 
  )
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  addFieldAliasMapping( ^
      schemaId: \"123\",  ^
      aliasMapping: { ^
        name: \"ECS for HAProxy\",  ^
        tags: [ {name: \"kind\", value: \"logs\"},  ^
                {name: \"repo\", value: \"github\"} ], ^
        aliases: [ {source: \"port\", alias: \"source.port\"} ] ^
      }  ^
  ) ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}'
    "$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 {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}';
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 {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}'''

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 {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}
);


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

Example Responses

Show:

json

{
  "data": {
    "addFieldAliasMapping": "c9vjksYPrvvGneUEjkkUFdyOKf9bcjvn"
  },
}

Given Datatypes

AddAliasMappingInput has a couple of parameters:

Table: AddAliasMappingInput

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 17, 2024
`aliasMapping`	`AliasMappingInput`	yes	`Long-Term`	The alias mapping to be added to the schema. See `AliasMappingInput`.
`schemaId`	string	yes	`Long-Term`	The unique identifier of the schema on which the alias mapping exists.

Example addFieldAliasMapping() Mutations

To create a new field alias mapping:

Show:

graphql

mutation {
  addFieldAliasMapping(
      schemaId: "123", 
      aliasMapping: {
        name: "ECS for HAProxy", 
        tags: [ {name: "kind", value: "logs"}, 
                {name: "repo", value: "github"} ],
        aliases: [ {source: "port", alias: "source.port"} ]
      } 
  )
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  addFieldAliasMapping( ^
      schemaId: \"123\",  ^
      aliasMapping: { ^
        name: \"ECS for HAProxy\",  ^
        tags: [ {name: \"kind\", value: \"logs\"},  ^
                {name: \"repo\", value: \"github\"} ], ^
        aliases: [ {source: \"port\", alias: \"source.port\"} ] ^
      }  ^
  ) ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}'
    "$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 {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}';
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 {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}'''

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 {
  addFieldAliasMapping(
      schemaId: \"123\", 
      aliasMapping: {
        name: \"ECS for HAProxy\", 
        tags: [ {name: \"kind\", value: \"logs\"}, 
                {name: \"repo\", value: \"github\"} ],
        aliases: [ {source: \"port\", alias: \"source.port\"} ]
      } 
  )
}"
}
);


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

Example Responses

Show:

json

{
  "data": {
    "addFieldAliasMapping": "c9vjksYPrvvGneUEjkkUFdyOKf9bcjvn"
  },
}

This mutation performs the action as when adding a new alias mapping for an individual field, as detailed on the Field Aliasing page.

The alias configuration from the above query, as shown within the UI is shown below:

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes