API Stability Deprecated

The addLimit() GraphQL mutation is used to add a limit to a given organization. This mutation field has been deprecated and will be removed at the earliest in version 1.201. Use instead addLimitV2().

To update a limit, use the updateLimitV2() mutation. You could also use the updateOrganizationLimits() for updating an organization's limits. You might find setLimitDisplayName() useful to set the display name for a limit, or the updateRepositoryLimitId() for changing the identifier of a repository limit. To remove a limit, use removeLimitWithId().

Hide Query Example

Show Limit Settings Query

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

Syntax

graphql
addLimit(
      input: AddLimitInput!
    ): boolean

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

Example

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 $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

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

For this input datatype, besides a giving a limit name, you'll have to give the daily ingest amount allowed. There are a few other parameters you may include. They're listed and described in the table below:

Table: AddLimitInput

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