disableFeatureForOrg()

🎯API Stability

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

Summary

The disableFeatureForOrg() mutation disables a feature flag for a single organization in LogScale. Org-level feature flags take effect for that organization only, leaving the cluster-wide feature state and other organizations unaffected. To disable a feature cluster-wide, use disableFeature() instead. To disable a feature for a specific user, use disableFeatureForUser().

To re-enable a feature for an organization, use enableFeatureForOrg(). To retrieve a list of features currently enabled, use the featureFlags() query. To enable or disable a feature globally, use enableFeature() or disableFeature(). To enable or disable a feature for a specific user, use enableFeatureForUser() or disableFeatureForUser().

Hide Query Example

Show Organizations Query

If you have more than one organization, you can get a list of organizations with the searchOrganizations() query like so:

graphql

query {
      searchOrganizations( sortBy: Name )
         { totalResults,
           results { organizationName} }
   }

For more information on enabling and disabling features, see the Enabling and Disabling Feature Flags reference page.

Syntax

graphql

disableFeatureForOrg(
      orgId: String!, feature: FeatureFlag!
   ): Boolean!

Both parameters are required. Provide the orgId identifying the target organization and the feature flag to disable. The mutation returns a non-null Boolean! confirming whether the operation succeeded.

Example

Raw

graphql

mutation {
  disableFeatureForOrg( 
    orgId: "SINGLE_ORGANIZATION_ID",
    feature: CancelQueriesExceedingAggregateOutputRowLimit )
}

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 {
  disableFeatureForOrg( 
    orgId: \"SINGLE_ORGANIZATION_ID\",
    feature: CancelQueriesExceedingAggregateOutputRowLimit )
}"
}
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 {
  disableFeatureForOrg( 
    orgId: \"SINGLE_ORGANIZATION_ID\",
    feature: CancelQueriesExceedingAggregateOutputRowLimit )
}"
}
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 { ^
  disableFeatureForOrg(  ^
    orgId: \"SINGLE_ORGANIZATION_ID\", ^
    feature: CancelQueriesExceedingAggregateOutputRowLimit ) ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  disableFeatureForOrg( 
    orgId: \"SINGLE_ORGANIZATION_ID\",
    feature: CancelQueriesExceedingAggregateOutputRowLimit )
}"
}'
    "$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 {
  disableFeatureForOrg( 
    orgId: \"SINGLE_ORGANIZATION_ID\",
    feature: CancelQueriesExceedingAggregateOutputRowLimit )
}";
$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 {
  disableFeatureForOrg( 
    orgId: \"SINGLE_ORGANIZATION_ID\",
    feature: CancelQueriesExceedingAggregateOutputRowLimit )
}"
}'''

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 {
  disableFeatureForOrg( 
    orgId: \"SINGLE_ORGANIZATION_ID\",
    feature: CancelQueriesExceedingAggregateOutputRowLimit )
}"
}
);


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

Input Parameters

Provide the unique identifier of the organization and the feature flag to disable. To find the organization identifier, select the Show Organizations Query link in the Related section for an example query.

Table: Input Parameters and Datatypes

Parameter	Type	Required	Default	Description
This table contains all input parameters for this mutation. Because one of the parameters uses a special datatype, an additional table is included below with its values.
orgId	String	yes		The unique identifier of the organization for which to disable the feature.

The feature parameter accepts a FeatureFlag enum value identifying the feature to disable for the organization. The following table lists the available enum values.

Versions of this Page

GraphQL Mutations

GraphQL API

GraphQL Queries

GraphQL Datatypes