API Stability Long-Term

The updateIPFilter() GraphQL mutation may be used to update an IP filter in LogScale.

For more information on IP filters, see the IP Filter reference page.

Syntax

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

graphql
updateIPFilter(
     input: IPFilterUpdateInput!
   ): IPFilter!

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

Show:
graphql
mutation {
  updateIPFilter( input:
       { id: "abc123"
         name: "my-filter",
         ipFilter: "deny all\ndeny 127.0.0.1\nallow 10.0.0.0/24\nallow 192.168.0.0/8\n"
      }
  )
  { id }
}
Example Responses
Show:
json
{
  "data": {
    "updateIPFilter": {
      "id": "abc123"
    }
  }
}

Given Datatypes

For IPFilterUpdateInput, there are a few parameters. Below is a list of them along with their a description of each:

Table: IPFilterUpdateInput

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 Long-TermThe unique identifier of the filter.
ipFilterstring  Long-TermAn IP filter to use, if there is one.
namestring  Long-TermThe name of the filter.

Returned Datatypes

The returned datatype IPFilter has a few parameters. Below is a list of them along with a description of each:

Table: IPFilter

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 25, 2024
idstringyes Long-TermThe unique identifier for the IP filter.
ipFilterstringyes Long-TermThe IP filter itself.
namestringyes Long-TermThe name for the IP filter.