Summary

The updateLocalClusterConnection() GraphQL mutation is used to update a cluster connection to a local view.

API Stability Short-Term

Syntax

graphql
updateLocalClusterConnection(
      input: UpdateLocalClusterConnectionInput!
   ): LocalClusterConnection!

For the input, you'll have to give the name or identifier of the multi-cluster view, and the identifier of the connection to update, along with whatever you want to change. Click on Show Query above to find the identifier. See the Input Parameters section for details.

For the results, you can get the local view with which to connect, and the identifiers of the cluster. See the Returned Values section for more.

Example

Raw
graphql
mutation {
  updateLocalClusterConnection( input:
    { multiClusterViewName: "my-gang",
      connectionId: "abc123",
      queryPrefix: "the_gang"
    }
  )
 { clusterId }
}
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 {
  updateLocalClusterConnection( input:
    { multiClusterViewName: \"my-gang\",
      connectionId: \"abc123\",
      queryPrefix: \"the_gang\"
    }
  )
 { clusterId }
}"
}
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 {
  updateLocalClusterConnection( input:
    { multiClusterViewName: \"my-gang\",
      connectionId: \"abc123\",
      queryPrefix: \"the_gang\"
    }
  )
 { clusterId }
}"
}
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 { ^
  updateLocalClusterConnection( input: ^
    { multiClusterViewName: \"my-gang\", ^
      connectionId: \"abc123\", ^
      queryPrefix: \"the_gang\" ^
    } ^
  ) ^
 { clusterId } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateLocalClusterConnection( input:
    { multiClusterViewName: \"my-gang\",
      connectionId: \"abc123\",
      queryPrefix: \"the_gang\"
    }
  )
 { clusterId }
}"
}'
    "$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 {
  updateLocalClusterConnection( input:
    { multiClusterViewName: \"my-gang\",
      connectionId: \"abc123\",
      queryPrefix: \"the_gang\"
    }
  )
 { clusterId }
}";
$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 {
  updateLocalClusterConnection( input:
    { multiClusterViewName: \"my-gang\",
      connectionId: \"abc123\",
      queryPrefix: \"the_gang\"
    }
  )
 { clusterId }
}"
}'''

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 {
  updateLocalClusterConnection( input:
    { multiClusterViewName: \"my-gang\",
      connectionId: \"abc123\",
      queryPrefix: \"the_gang\"
    }
  )
 { clusterId }
}"
}
);


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": {
    "updateLocalClusterConnection": {
      "clusterId": "def456"
    }
  }
}

Input Parameters

For the input, you'll have to give the name or the unique identifier of the multi-cluster view and the identifier of the connection to update, along with whatever you want to change. Click on the Show Query link above the Syntax section for an example of how to find the identifier.

Table: UpdateLocalClusterConnectionInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 23, 2024
connectionIdstringyes Short-TermThe unique identifier of the connection to update.
multiClusterViewNamestringyes Short-TermThe name or unique identifier of the multi-cluster view that has the connection.
queryPrefixstring  Short-TermFilter query that restricts the data visible through this connection.
tagsClusterConnectionInputTagyes Short-TermAdditional tags that can be used to filter queries. See ClusterConnectionInputTag.
targetViewNamestring  Short-TermThe name or unique identifier of the local view with which to connect.

Returned Values

For the results, you can get information on the local cluster connection, such as the local view with which to connect and the unique identifiers of the cluster.

Table: LocalClusterConnection Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Mar 26, 2025
clusterIdstringyes Short-TermThe cluster identity of the connection.
idstringyes Short-TermThe unique identifier of the connection.
queryPrefixstringyes Short-TermThe cluster connection query prefix.
tags[ClusterConnectionTag]yes Short-TermThe cluster connection tags. See ClusterConnectionTag.
targetViewIdstringyes Short-TermThe unique identifier of the local view with which to connect.
targetViewNameRepoOrViewNameyes Short-TermThe name of the local view with which to connect. RepoOrViewName is a scalar.
targetViewTypeLocalTargetTypeyes Short-TermThe type of target view. See LocalTargetType.