Security Requirements and Controls

The removeFile() GraphQL mutation is used to remove file from a LogScale server.

This mutation field is deprecated. It will be removed at the earliest in version 1.267. Use instead deleteFile().

To create a new file, you can use the newFile() mutation. To update a file, use the updateFile() mutation. You can use the query, getFileContent() to get information on a file.

Hide Query Example

Show Files Query

For information on loading and using files, see the Lookup Files documentation page.

API Stability Deprecated

Syntax

graphql
removeFile(
      fileName: string!,
      name: string!
   ): BooleanResultType!

You'll have to give the name of the file to delete and the repository where it's located. Click on Show Query above to get a list of files.

For the results, you'll receive confirmation if successful through a simple parameter. See the Returned Datatype section.

Example

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

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 {
  removeFile(
      name: \"humio\",
      fileName: \"my-lookup.csv\"
    )
  { result }
}"
}
);


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

Given Datatype

For this input, you'll have to give the name of the file to delete and the repository where it's located.

Table: Input Using Standard Datatypes

Parameter Type Required Default Description
fileName string yes   The name of the file to remove.
name string yes   The name of the repository.

Returned Datatype

For this datatype, the only result is whether the mutation was successful or not. The table below describes this:

Table: BooleanResultType

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 24, 2024
resultbooleanyes Long-TermWhether the mutation was performed successfully.