The updateRemoteClusterConnection() GraphQL mutation may be used to update a cluster connection to a remote view.

To create a remote cluster connection, use the createRemoteClusterConnection() mutation. Use the checkRemoteClusterConnection() query to check the connection. You can use deleteClusterConnection() to delete a connection.

Hide Query Example

Show Cluster Nodes Query

API Stability Short-Term

Syntax

graphql
updateRemoteClusterConnection(
      input: UpdateRemoteClusterConnectionInput!
   ): RemoteClusterConnection!

For the input, you'll have to give the identifier or name of the multi-cluster view, and that of the connection. You can set the URL and other parameters. Click on Show Query above to find the identifier. See the Given Datatype section for details on the input parameters.

For the results, you can get the public URL and the unique identifiers of the cluster that you can use with other mutations and queries. See the Returned Datatype section for more.

Example

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

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


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": {
    "updateRemoteClusterConnection": {
      "id": "abc123"
    }
  }
}

Given Datatype

For this input datatype, you would give the unique identifier or name of the associated multi-cluster view and that of the connection. You can set the parameter for the URL of the remote cluster, and other parameters. Click on the Show Query link above the Syntax section for an example of how to find the identifier.

Table: UpdateRemoteClusterConnectionInput

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: Feb 26, 2025
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.
publicUrlstring  Short-TermThe public URL of the remote cluster with which to connect.
queryPrefixstring  Short-TermThe filter query that restricts the data visible through this connection.
tags[ClusterConnectionInputTag]yes Short-TermAny additional tags that can be used to filter queries. See ClusterConnectionInputTag.
tokenstring  Short-TermThe access token for the remote view with which to connect.

Returned Datatype

With the returned datatype, you can get information on a remote cluster connection, such as the public URL and the unique identifiers of the cluster. To see all of your choices, click on the link for that sub-datatype in the table below:

Table: RemoteClusterConnection

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: Mar 17, 2025
clusterIdstringyes Short-TermCluster identity of the connection.
idstringyes Short-TermThe unique identifier of the connection.
publicUrlstringyes Short-TermPublic URL of the remote cluster with which to connect.
queryPrefixstringyes Short-TermThe cluster connection query prefix.
tags[ClusterConnectionTag]yes Short-TermCluster connection tags. See ClusterConnectionTag.