The deleteSearchDomain() GraphQL mutation may be used to delete a repository or view in LogScale by its name.

Similar to this mutation is deleteSearchDomainById() for deleting search domains by its unique identifier, instead. Related to these is the restoreDeletedSearchDomain() to restore a deleted search domain. There is also the searchDomains() query for getting a list of search domains.

For more information on searching repositories and views, see the Search Data documentation page.

API Stability Long-Term

Syntax

graphql
deleteSearchDomain(
      name: string!,
      deleteMessage: string
   ): BooleanResultType!

For the input, you'll have to give a name of the search domain to delete, the repository or view. You may also provide a message regarding the deletion. See the Given Datatype section.

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

Example

Raw
graphql
mutation {
  deleteSearchDomain( 
        name: "my-repository",
        deleteMessage: "It's Over!"
  )
  {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 {
  deleteSearchDomain( 
        name: \"my-repository\",
        deleteMessage: \"It's Over!\"
  )
  {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 {
  deleteSearchDomain( 
        name: \"my-repository\",
        deleteMessage: \"It's Over!\"
  )
  {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 { ^
  deleteSearchDomain(  ^
        name: \"my-repository\", ^
        deleteMessage: \"It's Over!\" ^
  ) ^
  {result} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  deleteSearchDomain( 
        name: \"my-repository\",
        deleteMessage: \"It's Over!\"
  )
  {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 {
  deleteSearchDomain( 
        name: \"my-repository\",
        deleteMessage: \"It's Over!\"
  )
  {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 {
  deleteSearchDomain( 
        name: \"my-repository\",
        deleteMessage: \"It's Over!\"
  )
  {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 {
  deleteSearchDomain( 
        name: \"my-repository\",
        deleteMessage: \"It's Over!\"
  )
  {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": {
    "deleteSearchDomain": {
      "result": true
    }
  }
}

Given Datatype

For the input, you'll have to give a name of the search domain to delete, the repository or view. You may also provide a message regarding the deletion.

Table: Input Using Standard Datatypes

Parameter Type Required Default Description
deleteMessage string     The message to record when deleting the search domain.
name string yes   The name of the repository or view to delete.

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.