Security Requirements and Controls

The blockIngest() GraphQL mutation is used to block ingest to a specified repository for a number of seconds. The maximum is one year.

For more information on blocking and unblocking ingesting data, see the Blocking and Unblocking Ingestion documentation page.

Syntax

Below is the syntax for the blockIngest() mutation:

graphql
blockIngest(
     repositoryName: string!
     seconds: integer!
   ): BlockIngestMutation!

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

Raw
graphql
mutation {
  blockIngest(repositoryName: "humio", seconds: 10)
  {repository {timeOfLatestIngest, ingestBlock} }
}
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 {
  blockIngest(repositoryName: \"humio\", seconds: 10)
  {repository {timeOfLatestIngest, ingestBlock} }
}"
}
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 {
  blockIngest(repositoryName: \"humio\", seconds: 10)
  {repository {timeOfLatestIngest, ingestBlock} }
}"
}
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 { ^
  blockIngest(repositoryName: \"humio\", seconds: 10) ^
  {repository {timeOfLatestIngest, ingestBlock} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  blockIngest(repositoryName: \"humio\", seconds: 10)
  {repository {timeOfLatestIngest, ingestBlock} }
}"
}'
"$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  blockIngest(repositoryName: \"humio\", seconds: 10)
  {repository {timeOfLatestIngest, ingestBlock} }
}"
}';
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 {
  blockIngest(repositoryName: \"humio\", seconds: 10)
  {repository {timeOfLatestIngest, ingestBlock} }
}"
}'''

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 {
  blockIngest(repositoryName: \"humio\", seconds: 10)
  {repository {timeOfLatestIngest, ingestBlock} }
}"
}
);


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": {
    "blockIngest": {
      "repository": {
        "timeOfLatestIngest": "2024-11-15T06:34:16.311Z",
        "ingestBlock": "2024-11-15T06:35:05.947Z"
      }
    }
  }
}

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, BlockIngestMutation. Below is a list of the parameters of that data type:

Table: BlockIngestMutation

ParameterTypeRequiredDefaultDescription
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 24, 2024
repositoryRepositoryyes The repository for which to block the query. See Repository.

The returned datatype has its own special datatypes. You can click on the links below for more information on its parameters: