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

Summary

The nonDefaultBucketConfigs() GraphQL query returns a list of organizations that have non-default bucket-storage configuration.

Syntax

graphql
nonDefaultBucketConfigs(): [OrgConfig!]!

This query takes no input. Returns a non-nullable list of OrgConfig objects — one per organization with a non-default bucket configuration. See the Returned Values section for available fields.

Example

Raw
graphql
query {
  nonDefaultBucketConfigs
   { id, name, prefix, 
     region, bucket }
}
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 {
  nonDefaultBucketConfigs
   { id, name, prefix, 
     region, bucket }
}"
}
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 {
  nonDefaultBucketConfigs
   { id, name, prefix, 
     region, bucket }
}"
}
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 { ^
  nonDefaultBucketConfigs ^
   { id, name, prefix,  ^
     region, bucket } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  nonDefaultBucketConfigs
   { id, name, prefix, 
     region, bucket }
}"
}'
    "$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 {
  nonDefaultBucketConfigs
   { id, name, prefix, 
     region, bucket }
}";
$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 {
  nonDefaultBucketConfigs
   { id, name, prefix, 
     region, bucket }
}"
}'''

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 {
  nonDefaultBucketConfigs
   { id, name, prefix, 
     region, bucket }
}"
}
);


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": {
    "nonDefaultBucketConfigs": {
      "id": "abc123",
      "name": "OutBucket",
      "prefix": "server1_",
      "region": "us-west-2",
      "bucket": "pale-1"
    }
  }
}

Returned Values

Returns a non-nullable list of OrgConfig objects. Each entry includes id (the organization ID), name (the organization name), region (the bucket region), bucket (the bucket name), and prefix (the bucket prefix). The table below lists all fields:

Table: OrgConfig Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
bucketStringyes Short-Term The bucket used.
idStringyes Short-Term The unique identifier of the organization.
nameStringyes Short-Term The name of the organization.
prefixStringyes Short-Term The prefix of the bucket.
regionStringyes Short-Term The region of the bucket.