The eventForwarders() GraphQL query will list all of the event forwarders associated with an organization.

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 eventForwarders() query field:

graphql
eventForwarders: [EventForwarder!]!

Using this query field is fairly simple. For EventForwarder, you would enter the parameters you want returned within curly-brackets The parameters are listed in the Given Datatypes section — after the example below:

Raw
graphql
query {
  eventForwarders {
    id, name, enabled, description
  }  
}
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" : "query {
  eventForwarders {
    id, name, enabled, description
  }  
}"
}
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" : "query {
  eventForwarders {
    id, name, enabled, description
  }  
}"
}
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" : "query { ^
  eventForwarders { ^
    id, name, enabled, description ^
  }   ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  eventForwarders {
    id, name, enabled, description
  }  
}"
}'
"$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" : "query {
  eventForwarders {
    id, name, enabled, description
  }  
}"
}';
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" : "query {
  eventForwarders {
    id, name, enabled, description
  }  
}"
}'''

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" : "query {
  eventForwarders {
    id, name, enabled, description
  }  
}"
}
);


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": {
    "eventForwarders": [
      {
        "id": "RhLcbl3OJcjfIOmfPyLxVUpR9I2Fma6K",
        "name": "Majordomo",
        "enabled": true,
        "description": "Major event forwarder.\n"
      }
    ]
  }
}

Given Datatypes

For the given datatype, EventForwarder, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: EventForwarder

ParameterTypeRequiredDefaultDescription
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 17, 2024
descriptionstringyes A description of the event forwarder.
enabledstringyes Whether the event forwarder is enabled.
idstringyes The unique identifier of the event forwarder.
namestringyes The name of the event forwarder.