🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

In a multi-tenant LogScale deployment, each organization operates under a set of contract limits that cap its ingest throughput, data retention period, and user count. These organization-level limits are separate from named per-repository limits and represent the overall quota assigned to the organization by the platform administrator.

The updateOrganizationLimits() mutation sets or replaces those contract limits for an organization. You supply the daily ingest ceiling in bytes (ingest), the maximum data retention in days (retention), the maximum number of users (users), an expiry timestamp for the limits (expiration), and whether the organization can adjust its own limits (allowSelfService). This is a system-level administrative operation. To update an individual named limit by its identifier, use updateLimitV2() instead.

Syntax

graphql
updateOrganizationLimits(
      input: OrganizationLimitsInput!
   ): Organization!

The mutation accepts a single required argument, input, of type OrganizationLimitsInput!. The input specifies the daily ingest ceiling, data retention period, user count, expiry timestamp, and self-service flag for the organization.

The mutation returns an Organization! object. The return type is non-null, so the mutation always returns the updated organization on success.

Input parameters

The input argument accepts an OrganizationLimitsInput! object. Provide the daily ingest ceiling in bytes (ingest), the number of days to retain data (retention), the maximum number of users (users), the expiry timestamp for the limits (expiration), and whether the organization can adjust its own limits (allowSelfService). The following table describes all available fields:

Table: OrganizationLimitsInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
allowSelfServiceBoolean  Short-Term Whether self service is enabled for the Organization, allowing features like creating repositories and setting retention.
contractVersionOrganizations__ContractVersion  Short-Term Which version of the LogScale contract applies. See Organizations__ContractVersion.
expirationLongyes Short-Term The expiration data of the organization limits.
ingestLongyes Short-Term Ingest in bytes.
retentionIntyes Short-Term Retention in days.
usersIntyes Short-Term The number of users allowed.

Example

Raw
graphql
mutation {
  updateOrganizationLimits( input:
    {
     ingest: 5000,
     retention: 30,
     users: 10,
     expiration: 1000,
     allowSelfService: false
    }
  )
 { id }
}
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 {
  updateOrganizationLimits( input:
    {
     ingest: 5000,
     retention: 30,
     users: 10,
     expiration: 1000,
     allowSelfService: false
    }
  )
 { id }
}"
}
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 {
  updateOrganizationLimits( input:
    {
     ingest: 5000,
     retention: 30,
     users: 10,
     expiration: 1000,
     allowSelfService: false
    }
  )
 { id }
}"
}
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 { ^
  updateOrganizationLimits( input: ^
    { ^
     ingest: 5000, ^
     retention: 30, ^
     users: 10, ^
     expiration: 1000, ^
     allowSelfService: false ^
    } ^
  ) ^
 { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateOrganizationLimits( input:
    {
     ingest: 5000,
     retention: 30,
     users: 10,
     expiration: 1000,
     allowSelfService: false
    }
  )
 { id }
}"
}'
    "$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 {
  updateOrganizationLimits( input:
    {
     ingest: 5000,
     retention: 30,
     users: 10,
     expiration: 1000,
     allowSelfService: false
    }
  )
 { id }
}";
$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 {
  updateOrganizationLimits( input:
    {
     ingest: 5000,
     retention: 30,
     users: 10,
     expiration: 1000,
     allowSelfService: false
    }
  )
 { id }
}"
}'''

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 {
  updateOrganizationLimits( input:
    {
     ingest: 5000,
     retention: 30,
     users: 10,
     expiration: 1000,
     allowSelfService: false
    }
  )
 { id }
}"
}
);


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": {
    "updateOrganizationLimits": {
      "id": "abc123"
    }
  }
}

Returned values

The mutation returns the updated Organization! object. You can retrieve the organization identifier, name, contract limits, and associated metadata from the returned object. The following table lists the available fields:

Table: Organization Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
actionOrganizationAction):Booleanyes Short-Term The action to check if a user is allowed to perform on an organization.
cidString  Short-Term The CID corresponding to the organization.
configsOrganizationConfigsyes Short-Term Organization configurations and settings. See OrganizationDetails.
createdAtLong  Short-Term Date organization was created.
defaultCachePolicyCachePolicy  Short-Term The default cache policy of the organization. See CachePolicy. This is a preview and subject to change.
deletedAtLong  Short-Term Day organization was deleted if it was marked for deletion.
descriptionString  Short-Term The description for the Organization. Can be null.
detailsOrganizationDetailsyes Short-Term Any additional details related to the organization. See OrganizationDetails.
externalGroupSynchronizationBooleanyes Short-Term Whether there is group synchronization.
externalPermissionsBooleanyes Short-Term Whether permissions are managed externally.
idStringyes Short-Term The unique id for the Organization.
ingestUrlString  Short-Term The ingest URL for the organization.
limitsLimityes Short-Term Limits assigned to the organization. See Limit.
limitsV2LimitV2yes Short-Term Limits assigned to the organization. See LimitV2.
nameStringyes Short-Term The name for the Organization.
publicUrlString  Short-Term The public URL for the organization.
readonlyDashboardIPFilterString  Short-Term IP filter for readonly dashboard links.
searchDomainsSearchDomainyes Short-Term Search domains within the organization. See SearchDomain.
statsOrganizationStatsyes Short-Term Statistics of the organization. See OrganizationStats.
trialStartedAtLong  Short-Term Date organization's trial started.