netbox/docs/configuration/graphql-api.md

# GraphQL API Parameters

## GRAPHQL_ENABLED

!!! tip "Dynamic Configuration Parameter"

Default: `True`

Setting this to `False` will disable the GraphQL API.

---

## GRAPHQL_MAX_ALIASES

Default: `10`

The maximum number of queries that a GraphQL API request may contain.
Closes #17288: Limit the number of aliases within a GraphQL API requests to 10 (#17329) * Closes #17288: Limit the number of aliases within a GraphQL API request to 10 * Introduce GRAPHQL_MAX_ALIASES config parameter 2024-09-02 09:30:41 -04:00			`# GraphQL API Parameters`

			`## GRAPHQL_ENABLED`

			`!!! tip "Dynamic Configuration Parameter"`

Fixes #19255: Improved documentation consistency for configuration default values (#19258) 2025-04-24 09:57:55 -04:00			Default: `True`
Closes #17288: Limit the number of aliases within a GraphQL API requests to 10 (#17329) * Closes #17288: Limit the number of aliases within a GraphQL API request to 10 * Introduce GRAPHQL_MAX_ALIASES config parameter 2024-09-02 09:30:41 -04:00
#19634 Update values to ensure consistency when referencing values set (#19635) * Update values to ensure consistency when referencing values see\t * Update required-parameters.md For Updated Django Link * Update required-parameters.md to fix Django link * Update error-reporting.md Remove Number Formatting * Update docs/configuration/error-reporting.md --------- Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com> 2025-06-05 10:03:22 -04:00			Setting this to `False` will disable the GraphQL API.
Closes #17288: Limit the number of aliases within a GraphQL API requests to 10 (#17329) * Closes #17288: Limit the number of aliases within a GraphQL API request to 10 * Introduce GRAPHQL_MAX_ALIASES config parameter 2024-09-02 09:30:41 -04:00
			`---`

			`## GRAPHQL_MAX_ALIASES`

Fixes #19255: Improved documentation consistency for configuration default values (#19258) 2025-04-24 09:57:55 -04:00			Default: `10`
Closes #17288: Limit the number of aliases within a GraphQL API requests to 10 (#17329) * Closes #17288: Limit the number of aliases within a GraphQL API request to 10 * Introduce GRAPHQL_MAX_ALIASES config parameter 2024-09-02 09:30:41 -04:00
			`The maximum number of queries that a GraphQL API request may contain.`