🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The blockIngestOnOrg() mutation enables or disables ingest for an entire organization. When you block ingest, LogScale stops accepting new log data across all repositories and dataspaces in the organization. Existing data remains queryable. Apply this mutation during maintenance windows, when approaching storage limits, or when you need an immediate organization-wide data shutoff. To block ingest on a single repository for a defined number of seconds, use blockIngest() instead.

Syntax

graphql
blockIngestOnOrg(
      input: BlockIngestOnOrgInput!
   ): Organization!

The required input argument takes a BlockIngestOnOrgInput! object. That object has one required Boolean field, blockIngest. Set blockIngest to true to immediately halt ingest across the organization, or false to resume. Unlike blockIngest(), this mutation does not accept a duration — the block persists until you explicitly set blockIngest to false.

The mutation returns the updated Organization! object. Request ingestBlock to confirm the new blocked state.

Example

Raw
graphql
mutation {
  blockIngestOnOrg(input: 
     { blockIngest: true } )
  {id, name}
}
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 {
  blockIngestOnOrg(input: 
     { blockIngest: true } )
  {id, name}
}"
}
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 {
  blockIngestOnOrg(input: 
     { blockIngest: true } )
  {id, name}
}"
}
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 { ^
  blockIngestOnOrg(input:  ^
     { blockIngest: true } ) ^
  {id, name} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  blockIngestOnOrg(input: 
     { blockIngest: true } )
  {id, name}
}"
}'
    "$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 {
  blockIngestOnOrg(input: 
     { blockIngest: true } )
  {id, name}
}";
$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 {
  blockIngestOnOrg(input: 
     { blockIngest: true } )
  {id, name}
}"
}'''

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 {
  blockIngestOnOrg(input: 
     { blockIngest: true } )
  {id, name}
}"
}
);


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": {
    "blockIngestOnOrg": {
      "id": "org123",
      "name": "The Company"
    }
  }
}

Input Parameters

The BlockIngestOnOrgInput type has one required field. Set blockIngest to true to block all new ingest for the organization, or to false to resume ingest. There is no TTL or automatic expiry — the block remains in effect until you explicitly reverse it.

Table: BlockIngestOnOrgInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
blockIngestBooleanyes Long-Term The block to ingest on organization.

Returned Values

The mutation returns the updated Organization! object. Request ingestBlock to confirm the new blocked state. Other available fields include organization configuration, URLs, and usage limits.

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.