๐ŸŽฏAPI Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The deleteFieldAliasSchema() mutation permanently removes a field alias schema from the system. A field alias schema defines mappings between field names and canonical aliases, enabling consistent field normalization across views and organizations. Deletion is permanent and cannot be undone.

Before deleting, disable the schema on all views and organizations that have it active. Call disableFieldAliasSchemaOnView() for each view and disableFieldAliasSchemaOnOrg() for each organization.

Syntax

graphql
deleteFieldAliasSchema(
      input: DeleteFieldAliasSchema!
   ): Boolean!

The mutation accepts a required input argument of type DeleteFieldAliasSchema, which contains the unique identifier of the schema to delete. The mutation returns a non-null Boolean! value: true indicates successful deletion.

Example

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

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 {
  deleteFieldAliasSchema(input: 
       { schemaId: \"abc123\" }
  )
}"
}
);


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": {
    "deleteFieldAliasSchema": true
  }
}

Input Parameters

The required input argument takes a DeleteFieldAliasSchema object identifying the schema to delete. The following table describes the input fields.

Table: DeleteFieldAliasSchema Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
schemaIdStringyesย Long-Termย The unique identifier of the schema.