Can't filter by Parent Region in GraphQL #11799

New Issue

adam · 2025-12-29T21:49:59+01:00

adam commented

2025-12-29 21:49:59 +01:00

Originally created by @tyler-8 on GitHub (Oct 30, 2025).

NetBox Edition

NetBox Community

NetBox Version

v4.4.5

Python Version

3.12

Steps to Reproduce

Create a Tenant "Acme"
Create a region "Canada"
Create a region "Canada East" with "Canada" as its parent
Create a site "HQ" with "Canada East" as its region, and "Acme" as the Tenant.
Create a circuit (of any type, provider), with "Acme" as the Tenant.
Create a circuit termination for the circuit that terminates at "HQ" site.
Attempt the following GraphQL queries:

On circuit_list:

query circuits {
  circuit_list(
    filters: {status: ACTIVE, terminations: {site: {tenant: {name: {exact: "HQ"}}, region: {name: {exact: "Canada"}}}}}
  ) {
    cid
    provider {
      name
    }
    status
    terminations {
      termination {
        ... on SiteType {
          name
          region {
            name
          }
        }
      }
    }
  }
}

On site_list:

query siteList($siteFilters: SiteFilter) {
  site_list(filters: $siteFilters) {
    name
    description
    circuit_terminations {
      circuit {
        cid
        status
        provider {
          name
        }
        tags {
          name
        }
      }
    }
  }
}

JSON variables for second query:

{
  "siteFilters": {
    "status": "STATUS_ACTIVE",
    "tenant": {
      "name": {
        "exact": "Acme"
      }
    },
    "region": {
      "name": {
        "exact": "Canada"
      }
    }
  }
}

Expected Behavior

I would expect to see sites in the site list and circuits in the circuit list that match the target query.

Observed Behavior

An empty result set is returned in both cases. In the GUI and REST API, filtering by parent region returns results. The parent relationship is currently only tracked in RegionFilter with parent_id with no way to include the name (or other attributes) of the parent and requires a separate query to retrieve parent information first. Under the old filter syntax using the direct or parent region attributes worked to filter the query data. With Regions allowing for any number of nesting levels, it's cumbersome to write a query that captures the correct nesting-level for the target parent Region.

Originally created by @tyler-8 on GitHub (Oct 30, 2025). ### NetBox Edition NetBox Community ### NetBox Version v4.4.5 ### Python Version 3.12 ### Steps to Reproduce 1. Create a Tenant "Acme" 2. Create a region "Canada" 3. Create a region "Canada East" with "Canada" as its parent 4. Create a site "HQ" with "Canada East" as its region, and "Acme" as the Tenant. 5. Create a circuit (of any type, provider), with "Acme" as the Tenant. 6. Create a circuit termination for the circuit that terminates at "HQ" site. 7. Attempt the following GraphQL queries: On circuit_list: ```graphql query circuits { circuit_list( filters: {status: ACTIVE, terminations: {site: {tenant: {name: {exact: "HQ"}}, region: {name: {exact: "Canada"}}}}} ) { cid provider { name } status terminations { termination { ... on SiteType { name region { name } } } } } } ``` On site_list: ```graphl query siteList($siteFilters: SiteFilter) { site_list(filters: $siteFilters) { name description circuit_terminations { circuit { cid status provider { name } tags { name } } } } } ``` JSON variables for second query: ```json { "siteFilters": { "status": "STATUS_ACTIVE", "tenant": { "name": { "exact": "Acme" } }, "region": { "name": { "exact": "Canada" } } } } ``` ### Expected Behavior I would expect to see sites in the site list and circuits in the circuit list that match the target query. ### Observed Behavior An empty result set is returned in both cases. In the GUI and REST API, filtering by parent region returns results. The parent relationship is currently only tracked in `RegionFilter` with `parent_id` with no way to include the name (or other attributes) of the parent and requires a separate query to retrieve parent information first. Under the old filter syntax using the direct or parent region attributes worked to filter the query data. With Regions allowing for any number of nesting levels, it's cumbersome to write a query that captures the correct nesting-level for the target parent Region.

adam added the type: bug status: needs owner netbox severity: low labels 2025-12-29 21:49:59 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#11799