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

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

Syntax

Below is the syntax for the addOrUpdateQueryQuotaUserSettings() mutation field:

graphql
addOrUpdateQueryQuotaUserSettings(
      input: QueryQuotaUserSettingsInput!
    ): QueryQuotaUserSettings!

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 { __typename } }
}
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 { __typename } }
}"
}
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 { __typename } }
}"
}
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 { __typename } } ^
}" ^
} '
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 { __typename } }
}"
}'
"$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

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

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 { __typename } }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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": [
        {
          "__typename": "QueryQuotaIntervalSetting"
        }
      ]
    }
  }
}

Given Datatypes

For the input (i.e., QueryQuotaUserSettingsInput), there are a couple of parameters that may be given. Below is a list of them along with their datatype and a description of each:

Table: QueryQuotaUserSettingsInput

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 19, 2024
settings[QueryQuotaIntervalSettingInput]yes The query quota settings for the user. See QueryQuotaIntervalSettingInput.
usernamestringyes The username for which to set the query quota.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, queryQuotaUserSettings(). Below is a list of the parameters of that datatype:

Table: QueryQuotaUserSettings

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 2, 2024
settings[QueryQuotaIntervalSetting]yes List of the settings that apply. See QueryQuotaIntervalSetting.
usernamestringyes Username of the user for which these Query Quota Settings apply.