API Stability Long-Term

The createIPFilter() GraphQL mutation may be used to create a new IP filter.

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

Syntax

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

graphql
createIPFilter(
      input: IPFilterInput!
   ): IPFilter!

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

Show:
graphql
mutation {
  createIPFilter(input:
       { name: "no-local-filter"
         ipFilter: "deny 127.0.0.1" } )
  { id }
}
Example Responses
Show:
json
{
  "data": {
    "createIPFilter": {
      "id": "Qh1jpLGO2jfN0uSvla53FlyPlO1gqtVb"
    }
  }
}

Given Datatypes

For IPFilterInput, there are a couple of parameters that may be given. Below is a list of them:

Table: IPFilterInput

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
ipFilterstringyes Long-TermThe IP filter to use.
namestringyes Long-TermThe name of the IP filter.

Returned Datatypes

For IPFilter, there are a few parameters. Below is a list of them along with descriptions 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.