updateLimit()

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 & Standards for related information.

Syntax

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

graphql

updateLimit(
     input: UpdateLimitInput!
   ): boolean!

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

Show:

graphql

mutation {
  updateLimit( input: 
    { limitName: "my-limit",
      userLimit: 10 }
  )
}

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

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

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 } ^
  ) ^
}" ^
} '

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

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

#! /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)

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

Show:

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

Parameter	Type	Required	Stability	Description
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
`allowLogin`	boolean		`Deprecated`	Whether the limit allows logging in.
`allowSelfService`	boolean		`Deprecated`	Whether self service is enabled for the organization, allowing features like creating repositories and setting retention.
`contractVersion`	`Organizations__ContractVersion`		`Deprecated`	Which version of the LogScale contract applies. The datatype, `Organizations__ContractVersion` is an enumerated list: `Version1`, `Version2`. or `Unknown`.
`dailyIngest`	long		`Deprecated`	The daily ingest allowed for the limit.
`expiration`	long		`Deprecated`	The expiration date for the email action.
`limitName`	string	yes	`Deprecated`	The name of the limit.
`retention`	integer		`Deprecated`	The retention in days allowed for the limit.
`userLimit`	integer		`Deprecated`	The limit for users.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes

updateLimit()

Syntax

Given Datatypes

Enter search term