The addLimit() GraphQL mutation is used to add a limit to a given organization.

For more information on query quotas, see the Query Quotas documentation page. You may also want to look at Limits & Standards for related information.

Syntax

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

graphql
addLimit(
      input: AddLimitInput!
    ): boolean!

In the syntax above, you would replace AddLimitInput with arguments required or allowed by that input definition (see the AddLimitInput table below). A boolean value is always returned that your API client may capture and use.

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

Raw
graphql
mutation {
  addLimit(input: 
       {limitName: "limiter2", 
        allowLogin: true, allowSelfService: true,
        dailyIngest: 10000, retention: 30} )
}
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 {
  addLimit(input: 
       {limitName: \"limiter2\", 
        allowLogin: true, allowSelfService: true,
        dailyIngest: 10000, retention: 30} )
}"
}
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 {
  addLimit(input: 
       {limitName: \"limiter2\", 
        allowLogin: true, allowSelfService: true,
        dailyIngest: 10000, retention: 30} )
}"
}
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 { ^
  addLimit(input:  ^
       {limitName: \"limiter2\",  ^
        allowLogin: true, allowSelfService: true, ^
        dailyIngest: 10000, retention: 30} ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addLimit(input: 
       {limitName: \"limiter2\", 
        allowLogin: true, allowSelfService: true,
        dailyIngest: 10000, retention: 30} )
}"
}'
    "$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 {
  addLimit(input: 
       {limitName: \"limiter2\", 
        allowLogin: true, allowSelfService: true,
        dailyIngest: 10000, retention: 30} )
}"
}';
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 {
  addLimit(input: 
       {limitName: \"limiter2\", 
        allowLogin: true, allowSelfService: true,
        dailyIngest: 10000, retention: 30} )
}"
}'''

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 {
  addLimit(input: 
       {limitName: \"limiter2\", 
        allowLogin: true, allowSelfService: true,
        dailyIngest: 10000, retention: 30} )
}"
}
);


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

Given Datatypes

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

Table: AddLimitInput

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 17, 2024
allowLoginbooleanyes Whether the limit allows logging in.
allowSelfServicebooleanyes Whether the limit allows self-service.
contractVersionOrganizations__ContractVersion  The version of the contract, using the enumerate list of Organizations__ContractVersion: Unknown, Version1, or Version2.
dailyIngestlongyes The daily ingest allowed for the limit.
expirationlong  The expiration date for the limit.
limitNamestringyes The name of the limit to add.
retentionintegeryes The retention in days allowed for the limit.
userLimitinteger  The limit for users.

One of these parameters uses Organizations__ContractVersion. This is just an enumerated list of choices: Unknown; Version1; or Version2.