API Stability Long-Term

The createEventForwardingRule() GraphQL mutation field is used to create an event forwarding rule on a repository and return it.

For more information on event forwarding 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

graphql
createEventForwardingRule(
      input: CreateEventForwardingRule!
   ): EventForwardingRule!

Example

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

Raw
graphql
mutation {
  createEventForwardingRule(input:
      { repoName: "humio",
        queryString: "@host=localhost",
        eventForwarderId: "RhLcbl3OJcjfIOmfPyLxVUpR9I2Fma6K",
        languageVersion: legacy
      } )
  { id }
}
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 {
  createEventForwardingRule(input:
      { repoName: \"humio\",
        queryString: \"@host=localhost\",
        eventForwarderId: \"RhLcbl3OJcjfIOmfPyLxVUpR9I2Fma6K\",
        languageVersion: legacy
      } )
  { id }
}"
}
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 {
  createEventForwardingRule(input:
      { repoName: \"humio\",
        queryString: \"@host=localhost\",
        eventForwarderId: \"RhLcbl3OJcjfIOmfPyLxVUpR9I2Fma6K\",
        languageVersion: legacy
      } )
  { id }
}"
}
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 { ^
  createEventForwardingRule(input: ^
      { repoName: \"humio\", ^
        queryString: \"@host=localhost\", ^
        eventForwarderId: \"RhLcbl3OJcjfIOmfPyLxVUpR9I2Fma6K\", ^
        languageVersion: legacy ^
      } ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createEventForwardingRule(input:
      { repoName: \"humio\",
        queryString: \"@host=localhost\",
        eventForwarderId: \"RhLcbl3OJcjfIOmfPyLxVUpR9I2Fma6K\",
        languageVersion: legacy
      } )
  { id }
}"
}'
    "$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 {
  createEventForwardingRule(input:
      { repoName: \"humio\",
        queryString: \"@host=localhost\",
        eventForwarderId: \"RhLcbl3OJcjfIOmfPyLxVUpR9I2Fma6K\",
        languageVersion: legacy
      } )
  { id }
}";
$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 {
  createEventForwardingRule(input:
      { repoName: \"humio\",
        queryString: \"@host=localhost\",
        eventForwarderId: \"RhLcbl3OJcjfIOmfPyLxVUpR9I2Fma6K\",
        languageVersion: legacy
      } )
  { id }
}"
}'''

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 {
  createEventForwardingRule(input:
      { repoName: \"humio\",
        queryString: \"@host=localhost\",
        eventForwarderId: \"RhLcbl3OJcjfIOmfPyLxVUpR9I2Fma6K\",
        languageVersion: legacy
      } )
  { id }
}"
}
);


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": {
    "createEventForwardingRule": {
      "id": "CiTUcuRYTtZIRfzqbhyBzn9O6HRehy9R"
    }
  }
}

Given Datatype

For this input datatype, you would provide the name of the repository associated with the event forwarding rule, the query for filtering and mapping events. These are listed and explained in the table below:

Table: CreateEventForwardingRule

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: Mar 28, 2025
eventForwarderIdstringyes Long-TermThe id of the event forwarder.
languageVersionLanguageVersionEnumyeslegacyLong-TermThe version of Human language to use: legacy, xdr1, or xdrdetects1. If non-null, it will be a version known by the current LogScale installation. See LanguageVersionEnum.
queryStringstringyes Long-TermThe query string for filtering and mapping the events to forward.
repoNamestringyes Long-TermThe name of the repository of the event forwarding rule.

Returned Datatype

The returned datatype can provide the unique identifier for the event forwarding rule, the query string for filtering and mapping events to forward, and other details Below is a list of parameters you can request, along with descriptions:

Table: EventForwardingRule

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: Mar 26, 2025
createdAtlong  Long-TermThe UNIX timestamp of when the event forwarder was created.
eventForwarderIdstringyes Long-TermThe unique identifier of the event forwarder.
idstringyes Long-TermThe unique identifier for the event forwarding rule.
languageVersionLanguageVersionyes Long-TermThe version of the LogScale query language to use. See LanguageVersion.
queryStringstringyes Long-TermThe query string for filtering and mapping the events to forward.