API Stability Deprecated

The updateLimit() GraphQL mutation is used to update the limits with a given name. Only the arguments defined will be updated. This mutation field is deprecated and it will be removed in version 1.201. Use instead updateLimitV2().

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

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

graphql
updateLimit(
     input: UpdateLimitInput!
   ): boolean

There is no special returned datatype for this mutation field. Below is an example of how it might be used:

Raw
graphql
mutation {
  updateLimit( input: 
    { limitName: "my-limit",
      userLimit: 10 }
  )
}
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 {
  updateLimit( input: 
    { limitName: \"my-limit\",
      userLimit: 10 }
  )
}"
}
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 {
  updateLimit( input: 
    { limitName: \"my-limit\",
      userLimit: 10 }
  )
}"
}
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 { ^
  updateLimit( input:  ^
    { limitName: \"my-limit\", ^
      userLimit: 10 } ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateLimit( input: 
    { limitName: \"my-limit\",
      userLimit: 10 }
  )
}"
}'
    "$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 {
  updateLimit( input: 
    { limitName: \"my-limit\",
      userLimit: 10 }
  )
}";
$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 {
  updateLimit( input: 
    { limitName: \"my-limit\",
      userLimit: 10 }
  )
}"
}'''

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 {
  updateLimit( input: 
    { limitName: \"my-limit\",
      userLimit: 10 }
  )
}"
}
);


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

Given Datatypes

For UpdateLimitInput, there are several parameters. Below is a list of them along with a description of each:

Table: UpdateLimitInput

ParameterTypeRequiredDefaultStabilityDescription
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 23, 2024
allowLoginboolean  DeprecatedWhether the limit allows logging in.
allowSelfServiceboolean  DeprecatedWhether self service is enabled for the organization, allowing features like creating repositories and setting retention.
contractVersionOrganizations__ContractVersion  DeprecatedWhich version of the LogScale contract applies. See Organizations__ContractVersion.
dailyIngestlong  DeprecatedThe daily ingest allowed for the limit.
expirationlong  DeprecatedThe expiration date for the email action.
limitNamestringyes DeprecatedThe name of the limit.
retentioninteger  DeprecatedThe retention in days allowed for the limit.
userLimitinteger  DeprecatedThe limit for users.