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!

Given Datatypes

For the input IPFilterInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: IPFilterInput

ParameterTypeRequired[a]DefaultDescription
namestringyes Name of the IP filter.
ipFilterstringyes The IP filter to use.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


Returned Datatypes

The returned datatype IPFilter has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: IPFilter

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier for the IP filter.
namestringyes The name for the IP filter.
ipFilterstringyes The IP filter itself.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.