API Stability Long-Term

The ipFilters() GraphQL query returns a list of IP filters for the organization.

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

Syntax

Below is the syntax for the ipFilters() query field:

graphql
ipFilters: [IPFilter!]!

This query fiend has no input, just return values. You enter the parameters you want returned within curly-brackets. See the example here:

Show:
graphql
query {
  ipFilters {id, name, ipFilter}
}
Example Responses
Show:
json
{
  "data": {
    "ipFilters": [
      {
        "id": "kyjiAKYGUo83gtiqs798uQZocjqFBcKB",
        "name": "OurFilter",
        "ipFilter": " deny all\ndeny 127.0.0.1\nallow 10.0.0.0/24\nallow 192.168.0.0/8\n"
      }
    ]
  }
}

Returned Datatypes

The returned datatype IPFilter has a few parameters. Below is a list of them:

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.