API Stability |
Long-Term
|
The updateEventForwardingRule() GraphQL mutation is used to update an event forwarding rule on a repository in LogScale 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
Below is the syntax for the updateEventForwardingRule() mutation field:
updateEventForwardingRule(
input: UpdateEventForwardingRule!
): EventForwardingRule!
Below is an example of how this mutation field might be used:
mutation {
updateEventForwardingRule( input:
{ repoName: "humio",
id: "Je78dClqEQsANYk0ZYh8ZdpKvFXVHL"
queryString: "@host=localhost",
eventForwarderId: "RhLcbl3OJcjfIOmfPyLxVUpR9I2Fma6K",
languageVersion: legacy
}
)
{ id }
}
{
"data": {
"updateEventForwardingRule": {
"id": "Je78dClqEQsANYk0ZYh8ZdpKvFXVHL"
}
}
}
Given Datatypes
For updateEventForwardingRule, there are a few parameters. Below is a list of them along with a description of each:
Table: UpdateEventForwardingRule
Security Requirements and Controls
EventForwarding
API permission
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
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: Mar 28, 2025 | |||||
eventForwarderId | string | yes | Long-Term | The unique identifier of the event forwarder. | |
id | string | yes | Long-Term | The unique identifier for the event forwarding rule. | |
languageVersion | LanguageVersionEnum | legacy | Long-Term | The version of Human language to use. If non-null, it will be a version known by the current LogScale installation. See LanguageVersionEnum . | |
queryString | string | yes | Long-Term | The query string for filtering and mapping the events to forward. | |
repoName | string | yes | Long-Term | The name of the repository associated with the event forwarding rule. |
Returned Datatypes
The returned datatype EventForwardingRule has several parameters. Below is a list of them along with a description of each:
Table: EventForwardingRule
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
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: Mar 26, 2025 | |||||
createdAt | long | Long-Term | The UNIX timestamp of when the event forwarder was created. | ||
eventForwarderId | string | yes | Long-Term | The unique identifier of the event forwarder. | |
id | string | yes | Long-Term | The unique identifier for the event forwarding rule. | |
languageVersion | LanguageVersion | yes | Long-Term | The version of the LogScale query language to use. See LanguageVersion . | |
queryString | string | yes | Long-Term | The query string for filtering and mapping the events to forward. |