API StabilityLongTerm

The deleteEventForwardingRule() GraphQL mutation may be used to delete an event forwarding rule on a repository in LogScale.

For more information on event forwardering rules, see the Event Forwarding Rules documentation page. You may also want to look at the Event Forwarding and the Events page for related information.

Syntax

Below is the syntax for the deleteEventForwardingRule() mutation field:

graphql
deleteEventForwardingRule(
     input: DeleteEventForwardingRule!
   ): boolean!

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

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

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 {
  deleteEventForwardingRule( input: 
       { viewName: \"humio\", 
         id: \"WKoeRcQ0EpuUskKvIJrGSXunEQZ09kU1\"}
  )
}"
}
);


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

Given Datatypes

For deleteEventForwardingRule, there are only two parameters that may be given. They're described below:

Table: DeleteEventForwardingRule

ParameterTypeRequiredDefaultStabilityDescription
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 18, 2024
idstringyes  Unique identifier of the event forwarding rule.
repoNamestringyes  The name of the repository associated with the event forwarding rule.