The deleteFile() GraphQL mutation is used to delete a file. It will return true if successful, false if the file does not exist, and null with errors for other failures.

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.

Stability Level Long-Term

Syntax

graphql
deleteFile(
       fileName: string!, 
       name: string!
    ): boolean

For the input, you'll have to provide the name of the file to delete, and the name of the related view or repository. See the Input Parameters section.

For the results, you'll receive confirmation if successful.

Example

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

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


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

Input Parameters

You'll have to provide the name of the file to delete, and the name of the related view or repository — where the file can be found. The table below lists and describes these parameters:

Table: Input Using Standard Datatypes

Parameter Type Required Default Description
fileName string yes   The name of the file.
name string yes   The name of the view or repository.