checkLocalClusterConnection()

API Stability	`Short-Term`

The checkLocalClusterConnection() GraphQL query is used to validate a local cluster connection.

Syntax

Below is the syntax for the checkLocalClusterConnection() query field:

graphql

checkLocalClusterConnection(
      input: CheckLocalClusterConnectionInput!
   ): LocalClusterConnectionStatus!

For the input, there are only a few required parameters, with one using a special datatype. It's described in the next section. The return datatype, LocalClusterConnectionStatus is described in the subsequent section. Here's an example of how this query might be used:

Show:

graphql

query {
	checkLocalClusterConnection(
	   input:{targetViewName: "humio"}
	) 
	  {id, viewName, isValid, 
	   errorMessages{error} }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	checkLocalClusterConnection(
	   input:{targetViewName: \"humio\"}
	) 
	  {id, viewName, isValid, 
	   errorMessages{error} }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	checkLocalClusterConnection(
	   input:{targetViewName: \"humio\"}
	) 
	  {id, viewName, isValid, 
	   errorMessages{error} }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
	checkLocalClusterConnection( ^
	   input:{targetViewName: \"humio\"} ^
	)  ^
	  {id, viewName, isValid,  ^
	   errorMessages{error} } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
	checkLocalClusterConnection(
	   input:{targetViewName: \"humio\"}
	) 
	  {id, viewName, isValid, 
	   errorMessages{error} }
}"
}'
    "$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" : "query {
	checkLocalClusterConnection(
	   input:{targetViewName: \"humio\"}
	) 
	  {id, viewName, isValid, 
	   errorMessages{error} }
}"
}';
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" : "query {
	checkLocalClusterConnection(
	   input:{targetViewName: \"humio\"}
	) 
	  {id, viewName, isValid, 
	   errorMessages{error} }
}"
}'''

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" : "query {
	checkLocalClusterConnection(
	   input:{targetViewName: \"humio\"}
	) 
	  {id, viewName, isValid, 
	   errorMessages{error} }
}"
}
);


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": {
    "checkLocalClusterConnection": {
      "id": null,
      "viewName": "humio",
      "isValid": true,
      "errorMessages": []
    }
  }
}

For the input, the value given for CheckLocalClusterConnectionInput, is entered within curly-brackets. As for the returned results, the list of what you want is given in a comma-separated list within curly-brackets. Further down this page is a list of what's allowed.

Given Datatypes

For the given datatype, CheckLocalClusterConnectionInput, there are a few parameters. Below is a list of them along with descriptions of each:

Table: CheckLocalClusterConnectionInput

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

Returned Datatypes

For LocalClusterConnectionStatus, there are a few possible values returned, which are listed below:

Table: LocalClusterConnectionStatus

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
`errorMessages`	[`ConnectionAspectErrorType`]	yes	`Short-Term`	Errors if the connection is invalid. See `ConnectionAspectErrorType`.
`id`	string		`Short-Term`	The unique identifier of the connection.
`isValid`	boolean	yes	`Short-Term`	Whether the connection is valid.
`viewName`	string		`Short-Term`	The name of the local view.

GraphQL Queries

GraphQL API Stability

GraphQL Mutations

GraphQL Datatypes