๐ŸŽฏAPI Stability
PreviewThis API is under active development and may change significantly. Not recommended for production use.

Summary

The deleteRemoteTableLogScaleConnection() mutation removes a specific LogScale connection from a remote table configuration. Use this mutation when you want to replace or remove an individual connection without deleting the entire configuration. To remove the full remote table configuration, use deleteRemoteTableConfig() instead.

Syntax

graphql
deleteRemoteTableLogScaleConnection(
      input: DeleteRemoteTableLogScaleConnectionInput!
   ): Boolean!

The required input argument takes a DeleteRemoteTableLogScaleConnectionInput object. See the Input Parameters section for the fields in that object.

The mutation returns a non-null Boolean!. A successful deletion always returns true. A failed operation returns a non-200 response instead of a boolean value.

Example

Raw
graphql
mutation {
  deleteRemoteTableLogScaleConnection(
    input: { logScaleConfigName: "remote-table-1",
             remoteConnectionId: "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 {
  deleteRemoteTableLogScaleConnection(
    input: { logScaleConfigName: \"remote-table-1\",
             remoteConnectionId: \"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 {
  deleteRemoteTableLogScaleConnection(
    input: { logScaleConfigName: \"remote-table-1\",
             remoteConnectionId: \"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 { ^
  deleteRemoteTableLogScaleConnection( ^
    input: { logScaleConfigName: \"remote-table-1\", ^
             remoteConnectionId: \"abc123\" } ^
  )  ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  deleteRemoteTableLogScaleConnection(
    input: { logScaleConfigName: \"remote-table-1\",
             remoteConnectionId: \"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 {
  deleteRemoteTableLogScaleConnection(
    input: { logScaleConfigName: \"remote-table-1\",
             remoteConnectionId: \"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 {
  deleteRemoteTableLogScaleConnection(
    input: { logScaleConfigName: \"remote-table-1\",
             remoteConnectionId: \"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 {
  deleteRemoteTableLogScaleConnection(
    input: { logScaleConfigName: \"remote-table-1\",
             remoteConnectionId: \"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": {
    "deleteRemoteTableLogScaleConnection": "true"
    }
  }
}

Input Parameters

The input argument requires a DeleteRemoteTableLogScaleConnectionInput object with the name of the remote table configuration and the unique identifier of the connection to delete.