mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Merge branch 'develop-2.9' into docs-refresh

Browse Source
This commit is contained in:
Jeremy Stretch
2020-08-05 13:53:06 -04:00
parent 73756f7483 42ebf0a546
commit e0f67c9ee9
42 changed files with 333 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/rest-api/overview.md
View File

@@ -267,6 +267,10 @@ GET /api/ipam/prefixes/13980/?brief=1
The brief format is supported for both lists and individual objects.
### Excluding Config Contexts
When retrieving devices and virtual machines via the REST API, each will included its rendered [configuration context data](../models/extras/configcontext/) by default. Users with large amounts of context data will likely observe suboptimal performance when returning multiple objects, particularly with very high page sizes. To combat this, context data may be excluded from the response data by attaching the query parameter `?exclude=config_context` to the request. This parameter works for both list and detail views.
## Pagination
API responses which contain a list of many objects will be paginated for efficiency. The root JSON object returned by a list endpoint contains the following attributes: