Simple GraphQL Support

[tyler-8]

For anyone that wants to use GraphQL alongside pynetbox, this is a simple way you can extend the pynetbox.api class for your own uses. This helps reduce your imports and setting up an entirely separate HTTP session for GraphQL.

import pynetbox

class ApiWithGraphQl(pynetbox.api):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.gql_url = self.base_url.replace('/api', '/graphql/')
    def gql(self, query):
        payload = {'query': query}
        response = self.http_session.post(self.gql_url, json=payload, headers={'Authorization': f"Token {self.token}"})
        return response.json()

Then you can use it like you normally would, with GraphQL queries too!

nb = ApiWithGraphQl(url, token)

# Use the GraphiQL feature in your NetBox install to come up with queries.
query = """query {
  device_list(manufacturer: "cisco", status: "active", last_updated__gte: "2023-10-01") {
    name
    primary_ip4 {
      address
    }
  }
}"""

# If you need dynamic filtering, you can use f-strings if you double-brace all the non-f-string curly brackets

mfg = "cisco"

query = f"""query {{
  device_list(manufacturer: "{mfg}", status: "active", last_updated__gte: "2023-10-01") {{
    name
    primary_ip4 {{
      address
    }}
  }}
}}"""

my_devices = nb.gql(query)
circuits = nb.circuits.circuits.filter(status="active")

and you'll get your output (taken from demo.netbox.dev):

// my_devices
{
  "data": {
    "device_list": [
      {
        "name": "Beispielgerät",
        "primary_ip4": null
      },
      {
        "name": "Demo2",
        "primary_ip4": null
      },
      {
        "name": "DemoSwitch",
        "primary_ip4": null
      },
      {
        "name": "abc",
        "primary_ip4": {
          "address": "10.3.0.1/16"
        }
      },
      {
        "name": "fz01s1p0",
        "primary_ip4": null
      }
    ]
  }
}