🎯API Stability
PreviewThis API is under active development and may change significantly. Not recommended for production use.

Summary

The setForceStopOnIngestFeed() mutation force stops or resumes an ingest feed in a LogScale repository. Use it to halt ingestion from a specific feed without deleting it, or to resume a previously stopped feed. To remove a feed entirely, use deleteIngestFeed() instead.

Syntax

graphql
setForceStopOnIngestFeed(
      input: SetForceStopOnIngestFeed!
   ): Boolean!

The mutation takes a single required input argument of type SetForceStopOnIngestFeed, which specifies the target repository, the ingest feed ID, and the desired force-stop state. The mutation returns a non-null Boolean confirming whether the operation succeeded.

Example

Raw
graphql
mutation {
  setForceStopOnIngestFeed(
    input: { 
       repositoryName: "humio",
       id: "abc123",
       forceStopState: True
    }
}
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 {
  setForceStopOnIngestFeed(
    input: { 
       repositoryName: \"humio\",
       id: \"abc123\",
       forceStopState: True
    }
}"
}
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 {
  setForceStopOnIngestFeed(
    input: { 
       repositoryName: \"humio\",
       id: \"abc123\",
       forceStopState: True
    }
}"
}
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 { ^
  setForceStopOnIngestFeed( ^
    input: {  ^
       repositoryName: \"humio\", ^
       id: \"abc123\", ^
       forceStopState: True ^
    } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setForceStopOnIngestFeed(
    input: { 
       repositoryName: \"humio\",
       id: \"abc123\",
       forceStopState: True
    }
}"
}'
    "$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 {
  setForceStopOnIngestFeed(
    input: { 
       repositoryName: \"humio\",
       id: \"abc123\",
       forceStopState: True
    }
}";
$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 {
  setForceStopOnIngestFeed(
    input: { 
       repositoryName: \"humio\",
       id: \"abc123\",
       forceStopState: True
    }
}"
}'''

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 {
  setForceStopOnIngestFeed(
    input: { 
       repositoryName: \"humio\",
       id: \"abc123\",
       forceStopState: True
    }
}"
}
);


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": {
    "setForceStopOnIngestFeed": true
  }
}

Input Parameters

Provide the repository name, the unique identifier of the ingest feed, and the target force-stop state. The input parameters are described in the following table:

Table: SetForceStopOnIngestFeed Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
forceStopStateBooleanyes Preview Whether to force stop (true) or resume (false) the ingest feed.
idStringyes Preview The unique identifier of the ingest feed.
repositoryNameRepoOrViewNameyes Preview The name of the repository for the ingest feed. See RepoOrViewName is a scalar.

Returned Values

The mutation returns a non-null Boolean!. A value of true confirms that the force-stop state was applied successfully. A value of false indicates the operation did not succeed. If the specified feed or repository does not exist, the mutation returns an error rather than false.