🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The updateDescriptionForSearchDomain() mutation sets the human-readable description for a LogScale repository or view. Run this mutation after renaming a search domain or when its intended purpose changes. To retrieve the current description before updating, run the searchDomain() query.

Syntax

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

Both arguments are required. Provide the exact name of the target repository or view in name. Enter the replacement description text in newDescription. The mutation returns a non-null UpdateDescriptionMutation! object.

Input parameters

Both parameters are required. Provide the exact name of the target search domain and the replacement description text.

Table: Input parameters and datatypes

Parameter Type Required Default Description
This table lists all input parameters for this mutation.
name String! yes   The exact name of the repository or view to update. This is the search domain's unique identifier in LogScale, not a display label.
newDescription String! yes   The replacement description text for the search domain. This overwrites any existing description. Enter an empty string to clear the description.

Example

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 values

The mutation returns an UpdateDescriptionMutation! object. The returned object contains the updated description text.

Table: UpdateDescriptionMutation Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
descriptionStringyes Long-Term A description of the mutation.