API Stability Short-Term

The addOrUpdateQueryQuotaUserSettings() GraphQL mutation field is used to add or update query quota user settings.

To remove query quota settings for a user, use the removeQueryQuotaUserSettings() mutation. To set or change the default query quota, use addOrUpdateQueryQuotaDefaultSettings(). Use removeQueryQuotaDefaultSettings() to eliminate the default settings. Use resetQuota() to reset a quota to the default.

The queryQuotaUserSettings() query may be used to get the settings for a particular user. For monitoring query quotas, you can use queryQuotaUsage() to see a user's usage, and exceededQueryQuotas() for determining if a user has exceeded their query quota.

For more information on query quotas, see the Query Quotas documentation page.

Syntax

graphql
addOrUpdateQueryQuotaUserSettings(
      input: QueryQuotaUserSettingsInput!
    ): QueryQuotaUserSettings!

Example

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  addOrUpdateQueryQuotaUserSettings(input: 
       { username: "tester", 
         settings: [ {interval: PerDay, measurementKind: QueryCount, 
                      valueKind: Limited, value: 1000 } ] } )
  { settings { interval, value } }
}
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 {
  addOrUpdateQueryQuotaUserSettings(input: 
       { username: \"tester\", 
         settings: [ {interval: PerDay, measurementKind: QueryCount, 
                      valueKind: Limited, value: 1000 } ] } )
  { settings { interval, value } }
}"
}
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 {
  addOrUpdateQueryQuotaUserSettings(input: 
       { username: \"tester\", 
         settings: [ {interval: PerDay, measurementKind: QueryCount, 
                      valueKind: Limited, value: 1000 } ] } )
  { settings { interval, value } }
}"
}
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 { ^
  addOrUpdateQueryQuotaUserSettings(input:  ^
       { username: \"tester\",  ^
         settings: [ {interval: PerDay, measurementKind: QueryCount,  ^
                      valueKind: Limited, value: 1000 } ] } ) ^
  { settings { interval, value } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addOrUpdateQueryQuotaUserSettings(input: 
       { username: \"tester\", 
         settings: [ {interval: PerDay, measurementKind: QueryCount, 
                      valueKind: Limited, value: 1000 } ] } )
  { settings { interval, value } }
}"
}'
    "$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 {
  addOrUpdateQueryQuotaUserSettings(input: 
       { username: \"tester\", 
         settings: [ {interval: PerDay, measurementKind: QueryCount, 
                      valueKind: Limited, value: 1000 } ] } )
  { settings { interval, value } }
}";
$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 {
  addOrUpdateQueryQuotaUserSettings(input: 
       { username: \"tester\", 
         settings: [ {interval: PerDay, measurementKind: QueryCount, 
                      valueKind: Limited, value: 1000 } ] } )
  { settings { interval, value } }
}"
}'''

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 {
  addOrUpdateQueryQuotaUserSettings(input: 
       { username: \"tester\", 
         settings: [ {interval: PerDay, measurementKind: QueryCount, 
                      valueKind: Limited, value: 1000 } ] } )
  { settings { interval, value } }
}"
}
);


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": {
    "addOrUpdateQueryQuotaUserSettings": {
      "settings": [
        {
          "interval": "PerDay",
          "value": 1000
        }
      ]
    }
  }
}

Given Datatype

For this input datatype, you would provide the user name, and through sub-parameters, the query quota interval, how the quota is measured and other related information you want to add or update. The table below has a link to these sub-parameters:

Table: QueryQuotaUserSettingsInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 19, 2024
settings[QueryQuotaIntervalSettingInput]yes Short-TermThe query quota settings for the user. See QueryQuotaIntervalSettingInput.
usernamestringyes Short-TermThe username for which to set the query quota.

Returned Datatype

This returned datatype will provide, through sub-parameters, data on query quotas, including the interval used, how quotas are measured and other such information. Drill down using the link in the table below to get to the table for the sub-parameters:

Table: QueryQuotaUserSettings

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Oct 2, 2024
settings[QueryQuotaIntervalSetting]yes Short-TermList of the settings that apply. See QueryQuotaIntervalSetting.
usernamestringyes Short-TermUsername of the user for which these Query Quota settings apply.