createLocalClusterConnection()

API Stability	`Short-Term`

The createLocalClusterConnection() GraphQL mutation field is used to create a cluster connection to a local view. The feature, MultiClusterSearch has to be enabled. This is a preview and might be changed later.

Syntax

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

graphql

createLocalClusterConnection(
       input: CreateLocalClusterConnectionInput!
    ): LocalClusterConnection!

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

Show:

graphql

mutation {
  createLocalClusterConnection(input:
         {multiClusterViewName: "my-cluster",
          targetViewName: "humio",
        } )
  { id }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createLocalClusterConnection(input:
         {multiClusterViewName: \"my-cluster\",
          targetViewName: \"humio\",
        } )
  { id }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createLocalClusterConnection(input:
         {multiClusterViewName: \"my-cluster\",
          targetViewName: \"humio\",
        } )
  { id }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  createLocalClusterConnection(input: ^
         {multiClusterViewName: \"my-cluster\", ^
          targetViewName: \"humio\", ^
        } ) ^
  { id } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createLocalClusterConnection(input:
         {multiClusterViewName: \"my-cluster\",
          targetViewName: \"humio\",
        } )
  { 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 {
  createLocalClusterConnection(input:
         {multiClusterViewName: \"my-cluster\",
          targetViewName: \"humio\",
        } )
  { 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 {
  createLocalClusterConnection(input:
         {multiClusterViewName: \"my-cluster\",
          targetViewName: \"humio\",
        } )
  { 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 {
  createLocalClusterConnection(input:
         {multiClusterViewName: \"my-cluster\",
          targetViewName: \"humio\",
        } )
  { 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();

Given Datatypes

For CreateLocalClusterConnectionInput, there are a few parameters. Below is a list of them:

Table: CreateLocalClusterConnectionInput

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: Sep 17, 2024
`multiClusterViewName`	string	yes	The name or unique identifier of the multi-cluster view for which to add the connection.
`queryPrefix`	string	yes	Filter query that restricts the data visible through this connection.
`tags`	[`ClusterConnectionInputTag`]	yes	Additional tags that can be used to filter queries. See `ClusterConnectionInputTag`.
`targetViewName`	string	yes	The name or unique identifier of the local view.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, LocalClusterConnection. Below is the parameter of that datatype:

Table: LocalClusterConnection

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 26, 2025
`clusterId`	string	yes	`Short-Term`	The cluster identity of the connection.
`id`	string	yes	`Short-Term`	The unique identifier of the connection.
`queryPrefix`	string	yes	`Short-Term`	The cluster connection query prefix.
`tags`	`ClusterConnectionTag`	yes	`Short-Term`	The cluster connection tags. See `ClusterConnectionTag`.
`targetViewId`	string	yes	`Short-Term`	The unique identifier of the local view with which to connect.
`targetViewName`	`RepoOrViewName`	yes	`Short-Term`	The name of the local view with which to connect. `RepoOrViewName` is a scalar.
`targetViewType`	`LocalTargetType`	yes	`Short-Term`	The type of target view. See `LocalTargetType`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes