Summary

The findOrCreateBucketStorageEntity() GraphQL mutation may be used to set the primary bucket target for the organization.

API Stability Long-Term

Syntax

graphql
findOrCreateBucketStorageEntity(
      organizationId: string!
   ): integer

For the input, you need to give the unique identifier of the organization. To see how to get that, click on the Show Query link below. See the Input Parameters section for details.

For the results, you'll receive storage entity number.

Hide Query Example

Show Organizations Query

Example

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

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 {
  findOrCreateBucketStorageEntity (
    organizationId: \"SINGLE_ORGANIZATION_ID\"
    )
}"
}
);


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": {
    "findOrCreateBucketStorageEntity": 2
  }
}

Input Parameters

For the input, you need to give the unique identifier of the organization. To see how to get the identifier, click on the Show Query link in the Syntax section.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
organizationId string yes   The unique identifier of the organization.