updateRemoteClusterConnection()

API Stability	`Short-Term`

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

Syntax

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

graphql

updateRemoteClusterConnection(
      input: UpdateRemoteClusterConnectionInput!
   ): RemoteClusterConnection!

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

Show:

graphql

mutation {
  updateRemoteClusterConnection( input:
    {
      multiClusterViewName: "my-gang",
      connectionId: "abc123",
      queryPrefix: "the_gang"
    }
  ) 
  { id }
}

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

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

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 } ^
}" ^
} '

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

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

#! /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)

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/graphql',
  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

Show:

json

{
  "data": {
    "updateRemoteClusterConnection": {
      "id": "abc123"
    }
  }
}

Given Datatypes

For UpdateRemoteClusterConnectionInput, there are several parameters. Below is a list of them along with a description of each:

Table: UpdateRemoteClusterConnectionInput

Parameter	Type	Required	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Feb 26, 2025
`connectionId`	string	yes	The unique identifier of the connection to update.
`multiClusterViewName`	string	yes	The name or unique identifier of the multi-cluster view that has the connection.
`publicUrl`	string		The public URL of the remote cluster with which to connect.
`queryPrefix`	string		The filter query that restricts the data visible through this connection.
`tags`	[`ClusterConnectionInputTag`]		Any additional tags that can be used to filter queries. See `ClusterConnectionInputTag`.
`token`	string	yes	The access token for the remote view with which to connect.

Returned Datatypes

The returned datatype RemoteClusterConnection has several parameters. Below is a list of them along with a description of each:

Table: RemoteClusterConnection

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Mar 17, 2025
`clusterId`	string	yes	`Short-Term`	Cluster identity of the connection.
`id`	string	yes	`Short-Term`	The unique identifier of the connection.
`publicUrl`	string	yes	`Short-Term`	Public URL of the remote cluster with which to connect.
`queryPrefix`	string	yes	`Short-Term`	The cluster connection query prefix.
`tags`	[`ClusterConnectionTag`]	yes	`Short-Term`	Cluster connection tags. See `ClusterConnectionTag`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes