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

Summary

The getConnectedRemoteTableConfigsInView() GraphQL query returns all remote table configurations currently connected to a view, as a list. Credentials are redacted โ€” the return type RemoteTableConfigNonSensitive exposes connection names, descriptions, and non-sensitive configuration details only.

Syntax

graphql
getConnectedRemoteTableConfigsInView(
      input: GetRemoteTableConfigsInViewInput!
   ): [RemoteTableConfigNonSensitive!]!

Provide the view name as viewName. The query returns a non-nullable list of non-nullable RemoteTableConfigNonSensitive objects โ€” one entry per connected remote table. See Input Parameters and Returned Values for details.

Example

Raw
graphql
query {
  getConnectedRemoteTableConfigsInView(
    input: { fieldname: "something" }
  ) { id, name }
}
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" : "query {
  getConnectedRemoteTableConfigsInView(
    input: { fieldname: \"something\" }
  ) { id, name }
}"
}
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" : "query {
  getConnectedRemoteTableConfigsInView(
    input: { fieldname: \"something\" }
  ) { id, name }
}"
}
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" : "query { ^
  getConnectedRemoteTableConfigsInView( ^
    input: { fieldname: \"something\" } ^
  ) { id, name } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  getConnectedRemoteTableConfigsInView(
    input: { fieldname: \"something\" }
  ) { id, name }
}"
}'
    "$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 = "query {
  getConnectedRemoteTableConfigsInView(
    input: { fieldname: \"something\" }
  ) { id, name }
}";
$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" : "query {
  getConnectedRemoteTableConfigsInView(
    input: { fieldname: \"something\" }
  ) { id, name }
}"
}'''

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" : "query {
  getConnectedRemoteTableConfigsInView(
    input: { fieldname: \"something\" }
  ) { id, name }
}"
}
);


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": {
    "getConnectedRemoteTableConfigsInView": {
      "id": "123abc",
      "name": "humio"
    }
  }
}

Input Parameters

Provide the name of the view as viewName. This is the only required field.

Returned Values

The result is a non-nullable list of RemoteTableConfigNonSensitive objects, one per connected remote table. Each object has three fields: connectionName (the display name of the connection), connectionDescription (a description of the configuration), and connectionConfig (a RemoteTableGenericConnectionConfigNonSensitive object containing the remote URL and any connection parameters โ€” credentials and secrets are excluded from this type by design). The available fields are listed here: