Summary

The removeFile() mutation removes a file from a LogScale repository. This mutation is deprecated. Use deleteFile() instead.

The mutation returns a BooleanResultType indicating whether the deletion succeeded. LogScale will remove removeFile() no earlier than version 1.267.

Syntax

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

Both fileName and name are required. Provide the file name to delete and the name of the repository that contains it. Use the repository() query in the Related section to retrieve available file names.

The return type is BooleanResultType!, which is non-nullable. Request the result field to determine whether the deletion succeeded.

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
    }
  }
}

Input Parameters

Both parameters are required. Provide the file name and repository name to identify the file to delete.

Table: Input Parameters and Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
fileName string yes   The name of the file to remove from the repository. Use the repository() query to retrieve the names of files available in the target repository.
name string yes   The name of the repository that contains the file. This must match the repository name exactly.

Returned Values

The mutation returns BooleanResultType!. Request the result field to determine whether the deletion succeeded. A value of true confirms that LogScale removed the file from the repository.

Table: BooleanResultType Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
resultBooleanyes Long-Term Whether the mutation was performed successfully.