API Stability Long-Term

The updateReadonlyDashboardIPFilter() GraphQL mutation field is used to update the read-only dashboard IP filter.

For more information on dashboards, see the Dashboards & Widgets documentation page. You may also want to look at the IP Filter reference page in the language syntax section for related information.

Syntax

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

graphql
updateReadonlyDashboardIPFilter(
     ipFilter: string
   ): boolean!

There are no special datatypes for this mutation field.

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

Show:
graphql
mutation {
  updateReadonlyDashboardIPFilter(
       ipFilter: "deny all\ndeny 127.0.0.1\nallow 10.0.0.0/24\nallow 192.168.0.0/8\n"
  )
}
Example Responses
Show:
json
{
  "data": {
    updateReadonlyDashboardIPFilter: true
    }
  }
}