Make Prefix Utilization and Aggregate Utilization available via API

[emallette]

NetBox version

v2.11.12

Feature type

Data model extension

Proposed functionality

Currently, the UI displays the utilization for prefixes and aggregates - like that functionality. We would like to obtain the utilization via API as well. It appears that the utilization is being calculated on the fly to display in the API. Could you expose that to the API ?

Use case

There are a number of cases where it would be helpful:

1. We are programmatically allocating prefixes as part of our ordering system and today we are simply attempting to allocate prefix size FOO from block A, on failure we move to block B. We would like to be able to see the utilization of a block and quickly determine whether or not to attempt to allocate from that prefix or container.

2. We would like to be able to quickly generate our own utilization reports using the calculations already performed in Netbox rather than re-writing the same allocation logic and this would be helpful.

Database changes

No response

External dependencies

No response

[jeremystretch]

This was recently proposed under #6606 and did not seem to generate any interest. Please see my comment here on the likely avenues for implementation.

@emallette are you interested in owning this work?

[jeremystretch]

As I commented here, implementing this elegantly will probably require that we first pre-render utilization data for all aggregates, prefixes, and ranges. I've opened #7451 to explore the idea. This proposal should be considered blocked until a decision has been made on #7451.

[jeremystretch]

Also related to #7845