The blockIngest()
For more information on blocking and unblocking ingesting data, see
the Blocking and Unblocking Ingestion
documentation page.
Below is the syntax for the
blockIngest()
blockIngest(
repositoryName : string!
seconds : integer!
) : BlockIngestMutation!
Below is an example of how this mutation field might be used:
Show:
Raw Mac OS or Linux (curl) Mac OS or Linux (curl) One-line Windows Cmd and curl Windows Powershell and curl Perl Python Node.js
Raw mutation {
blockIngest( repositoryName : "humio" , seconds : 10 )
{ repository { timeOfLatestIngest, ingestBlock} }
} Mac OS or Linux (curl) 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} }
}"
}
EOFMac OS or Linux (curl) One-line 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} }
}"
}
EOFWindows Cmd and curl 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 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
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
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 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 Show:
Success (HTTP Response Code 200 OK)
Success (HTTP Response Code 200 OK) {
"data" : {
"blockIngest" : {
"repository" : {
"timeOfLatestIngest" : "2024-11-15T06:34:16.311Z" ,
"ingestBlock" : "2024-11-15T06:35:05.947Z"
}
}
}
}
As indicated by the syntax above, this mutation will return data
using the datatype,
BlockIngestMutation
Table: BlockIngestMutation
Parameter Type Required Default Stability Description Some arguments may be required, as indicated in the Required Table last updated: Sep 24, 2024 repositoryRepositoryyes Short-TermThe 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:
