API Stability Long-Term

The disableEventForwarder() GraphQL mutation may be used to disable an event forwarder.

Syntax

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

graphql
disableEventForwarder(
      input: DisableEventForwarderInput!
   ): boolean!

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

Show:
graphql
mutation {
  disableEventForwarder( input:
    { id: "Pel13mdcXL8NfyRvN4joCbnFgGvyRmje"
    } )
}
Example Responses
Show:
json
{
  "data": {
    "disableEventForwarder": true
  }
}

Given Datatypes

For DisableEventForwarderInput, there are two parameters. Each is described below:

Table: DisableEventForwarderInput

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  The unique identifier of the event forwarder.