deleteIngestListener()

🎯API Stability

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

Summary

The deleteIngestListener() mutation permanently removes an ingest listener from a LogScale repository. Ingest listeners receive data on a specific port and protocol and route it to a repository for storage and indexing. Deleting a listener immediately stops data flow on that port; clients still sending data to it receive no acknowledgment and their events are not ingested. The deletion cannot be undone.

To create an ingest listener, use createIngestListenerV3(). To modify an existing listener's configuration without deleting it, use updateIngestListenerV3().

Hide Query Example

Show Ingest Listeners Query

Use the repository() query to retrieve ingest listener IDs before calling this mutation:

graphql

query {
     repository( name: "humio" )
      { ingestListeners { id, name,
                          parser { id, name, description } }
       }
   }

For more information on ingest listeners, see the Ingest Listeners documentation page. See the Manage Data Ingest page for broader context on data ingestion.

Syntax

graphql

deleteIngestListener(
      id: String!
   ): BooleanResultType!

The required id argument is the unique identifier of the ingest listener to delete. Use the repository() query in the preceding Related section to retrieve listener IDs. The mutation returns a BooleanResultType indicating whether the deletion succeeded.

Example

Raw

graphql

mutation {
  deleteIngestListener(
       id: "abc123"
  )
}

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 {
  deleteIngestListener(
       id: \"abc123\"
  )
}"
}
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 {
  deleteIngestListener(
       id: \"abc123\"
  )
}"
}
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 { ^
  deleteIngestListener( ^
       id: \"abc123\" ^
  ) ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  deleteIngestListener(
       id: \"abc123\"
  )
}"
}'
    "$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 {
  deleteIngestListener(
       id: \"abc123\"
  )
}";
$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 {
  deleteIngestListener(
       id: \"abc123\"
  )
}"
}'''

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 {
  deleteIngestListener(
       id: \"abc123\"
  )
}"
}
);


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

Input Parameters

Provide the unique identifier of the ingest listener to delete. Retrieve this identifier from the repository() query before calling this mutation.

Table: Input Parameters & Datatypes

Parameter	Type	Required	Default	Description
This table contains all input parameters for this mutation.
id	string	yes		The unique identifier of the ingest listener to delete. Obtain this value from the ingestListeners.id field returned by the repository() query.

Returned Values

The mutation returns a BooleanResultType. A value of true confirms the listener was deleted successfully. A value of false indicates the deletion did not complete, which can occur if the specified listener ID does not exist or the requesting account lacks sufficient permissions. Check this value before updating dependent configurations such as log shipper endpoints or firewall rules for the listener's port.

Table: BooleanResultType Datatype

Parameter	Type	Required	Default	Stability	Availability	Description
result	Boolean	yes		`Long-Term`		Whether the mutation was performed successfully.

Versions of this Page

GraphQL Mutations

GraphQL API

GraphQL Queries

GraphQL Datatypes