🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

In a multi-cluster LogScale deployment, a cluster connection links a remote cluster node to a multi-cluster view so that searches against the view include data from that node. Removing the connection excludes the node from all subsequent searches on the view; existing data on the remote node is not affected, but the view can no longer access it until a new connection is created.

The deleteClusterConnection() mutation permanently removes a specified cluster connection from a multi-cluster view. Provide the name of the multi-cluster view and the identifier of the connection to remove. The deletion takes effect immediately. To restore access, create a new connection using the appropriate create cluster connection mutation.

Syntax

graphql
deleteClusterConnection(
      input: DeleteClusterConnectionInput!
   ): Boolean!

The required input argument takes a DeleteClusterConnectionInput! object containing the name of the multi-cluster view and the identifier of the connection to remove. See the Input Parameters section for field details.

The mutation returns a non-null Boolean! value. A return value of true confirms that the connection was deleted successfully.

Example

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

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 {
  deleteClusterConnection( input: {
         multiClusterViewName: \"humidor\",
         connectionId: \"abc123\"
  } )
}"
}
);


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": {
    "deleteClusterConnection": true
  }
}

Input Parameters

Provide the name of the multi-cluster view and the identifier of the connection to remove. To find connection identifiers, select the Show Cluster Nodes Query link in the preceding Related section for an example query.

Table: DeleteClusterConnectionInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
connectionIdStringyes Short-Term The unique identifier of the connection to delete.
multiClusterViewNameStringyes Short-Term The name or unique identifier of the multi-cluster view from which to delete the connection.

Returned Values

The mutation returns a non-null Boolean! value. A return value of true indicates the connection was deleted successfully. If the specified connection does not exist or cannot be deleted, the mutation returns an error rather than false.