API Stability Long-Term

The updateDescriptionForSearchDomain() GraphQL mutation field is used to update the description for a search domain in LogScale.

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

Syntax

Below is the syntax for the updateDescriptionForSearchDomain() mutation field:

graphql
updateDescriptionForSearchDomain(
      name: string!,
      newDescription: string!
   ): UpdateDescriptionMutation!

Below is an example of how this mutation field might be used:

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

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 {
  updateDescriptionForSearchDomain(
      name: \"humio\",
      newDescription: \"Owl Nook\"
  )
  { description }
}"
}
);


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": {
    "updateDescriptionForSearchDomain": {
      "description": "Owl Nook"
    }
  }
}

Returned Datatypes

The returned datatype UpdateDescriptionMutation has just one parameter. Below is a description of it:

Table: UpdateDescriptionMutation

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: Oct 4, 2024
descriptionstringyes Long-TermA description of the mutation.