The eventForwarders()
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.
Below is the syntax for the eventForwarders()
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:
Show:
Raw Mac OS or Linux (curl) Mac OS or Linux (curl) One-line Windows Cmd and curl Windows Powershell and curl Perl Python Node.js
Raw query {
eventForwarders {
id, name, enabled, description
}
} Mac OS or Linux (curl) 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
}
}"
}
EOFMac OS or Linux (curl) One-line 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
}
}"
}
EOFWindows Cmd and curl 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 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
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
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 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 Show:
Success (HTTP Response Code 200 OK)
Success (HTTP Response Code 200 OK) {
"data" : {
"eventForwarders" : [
{
"id" : "RhLcbl3OJcjfIOmfPyLxVUpR9I2Fma6K" ,
"name" : "Majordomo" ,
"enabled" : true ,
"description" : "Major event forwarder.\n"
}
]
}
}
For the given datatype, EventForwarder
Table: EventForwarder
Parameter Type Required Default Stability Description Some arguments may be required, as indicated in the Required Table last updated: Sep 17, 2024 descriptionstring yes Long-TermA description of the event forwarder. enabledstring yes Long-TermWhether the event forwarder is enabled. idstring yes Long-TermThe unique identifier of the event forwarder. namestring yes Long-TermThe name of the event forwarder.
