Stability Level Preview

The setForceStopOnIngestFeed() GraphQL mutation is used to force stop or resume an ingest feed.

To create an ingest feed, there are several mutations. Scan the list in the left margin for the type of ingest feed you want. To test an ingest feed in general, you can use the testIngestFeedById() mutation. To delete an ingest feed, use the deleteIngestFeed() mutation.

Hide Query Example

Show Ingest Feeds Query

Syntax

graphql
setForceStopOnIngestFeed(
       input: SetForceStopOnIngestFeed!
    ): boolean

There are no special return datatypes for this mutation field. True is returned if successful.

Example

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

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
  }
}

Given Datatype

For input datatype, you have to give the name of the repository, the unique identifier of the ingest feed, and indicate whether forcibly to stop or resume the ingest feed. These parameters are described below:

Table: SetForceStopOnIngestFeed

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Jun 30, 2025
forceStopStatebooleanyes PreviewWhether to force stop (true) or resume (false) the ingest feed.
idstringyes PreviewThe unique identifier of the ingest feed.
repositoryNameRepoOrViewNameyes PreviewThe name of the repository for the ingest feed. See RepoOrViewName is a scalar.