# paths./api/authentication-check/.get.description
Return the user making the request, if authenticated successfully.

# paths./api/circuits/circuit-group-assignments/.get.description
Get a list of Circuit group assignment objects.

# paths./api/circuits/circuit-group-assignments/.get.parameters[].description
The initial index from which to return the results.

# paths./api/circuits/circuit-group-assignments/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/circuits/circuit-group-assignments/.get.parameters[].description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# paths./api/circuits/circuit-group-assignments/.get.parameters[].description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# paths./api/circuits/circuit-group-assignments/.post.description
Post a list of Circuit group assignment objects.

# paths./api/circuits/circuit-group-assignments/.put.description
Put a list of Circuit group assignment objects.

# paths./api/circuits/circuit-group-assignments/.patch.description
Patch a list of Circuit group assignment objects.

# paths./api/circuits/circuit-group-assignments/.delete.description
Delete a list of Circuit group assignment objects.

# paths./api/circuits/circuit-group-assignments/{id}/.get.parameters[].description
A unique integer value identifying this Circuit group assignment.

# paths./api/circuits/circuit-group-assignments/{id}/.put.parameters[].description
A unique integer value identifying this Circuit group assignment.

# paths./api/circuits/circuit-group-assignments/{id}/.patch.description
Patch a Circuit group assignment object.

# paths./api/circuits/circuit-group-assignments/{id}/.patch.parameters[].description
A unique integer value identifying this Circuit group assignment.

# paths./api/circuits/circuit-group-assignments/{id}/.delete.description
Delete a Circuit group assignment object.

# paths./api/circuits/circuit-group-assignments/{id}/.delete.parameters[].description
A unique integer value identifying this Circuit group assignment.

# paths./api/circuits/circuit-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/circuits/circuit-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/circuits/circuit-groups/{id}/.get.parameters[].description
A unique integer value identifying this circuit group.

# paths./api/circuits/circuit-groups/{id}/.put.parameters[].description
A unique integer value identifying this circuit group.

# paths./api/circuits/circuit-groups/{id}/.patch.parameters[].description
A unique integer value identifying this circuit group.

# paths./api/circuits/circuit-groups/{id}/.delete.parameters[].description
A unique integer value identifying this circuit group.

# paths./api/circuits/circuit-terminations/.get.description
Get a list of circuit termination objects.

# paths./api/circuits/circuit-terminations/.get.parameters[].description
The initial index from which to return the results.

# paths./api/circuits/circuit-terminations/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/circuits/circuit-terminations/.post.description
Post a list of circuit termination objects.

# paths./api/circuits/circuit-terminations/.put.description
Put a list of circuit termination objects.

# paths./api/circuits/circuit-terminations/.patch.description
Patch a list of circuit termination objects.

# paths./api/circuits/circuit-terminations/.delete.description
Delete a list of circuit termination objects.

# paths./api/circuits/circuit-terminations/{id}/.get.parameters[].description
A unique integer value identifying this circuit termination.

# paths./api/circuits/circuit-terminations/{id}/.put.parameters[].description
A unique integer value identifying this circuit termination.

# paths./api/circuits/circuit-terminations/{id}/.patch.parameters[].description
A unique integer value identifying this circuit termination.

# paths./api/circuits/circuit-terminations/{id}/.delete.parameters[].description
A unique integer value identifying this circuit termination.

# paths./api/circuits/circuit-terminations/{id}/paths/.get.description
Return all CablePaths which traverse a given pass-through port.

# paths./api/circuits/circuit-terminations/{id}/paths/.get.parameters[].description
A unique integer value identifying this circuit termination.

# paths./api/circuits/circuit-types/.get.parameters[].description
The initial index from which to return the results.

# paths./api/circuits/circuit-types/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/circuits/circuit-types/{id}/.get.parameters[].description
A unique integer value identifying this circuit type.

# paths./api/circuits/circuit-types/{id}/.put.parameters[].description
A unique integer value identifying this circuit type.

# paths./api/circuits/circuit-types/{id}/.patch.parameters[].description
A unique integer value identifying this circuit type.

# paths./api/circuits/circuit-types/{id}/.delete.parameters[].description
A unique integer value identifying this circuit type.

# paths./api/circuits/circuits/.get.parameters[].description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# paths./api/circuits/circuits/.get.parameters[].description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# paths./api/circuits/circuits/.get.parameters[].description
The initial index from which to return the results.

# paths./api/circuits/circuits/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/circuits/circuits/{id}/.get.parameters[].description
A unique integer value identifying this circuit.

# paths./api/circuits/circuits/{id}/.put.parameters[].description
A unique integer value identifying this circuit.

# paths./api/circuits/circuits/{id}/.patch.parameters[].description
A unique integer value identifying this circuit.

# paths./api/circuits/circuits/{id}/.delete.parameters[].description
A unique integer value identifying this circuit.

# paths./api/circuits/provider-accounts/.get.parameters[].description
The initial index from which to return the results.

# paths./api/circuits/provider-accounts/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/circuits/provider-accounts/.post.description
Post a list of provider account objects.

# paths./api/circuits/provider-accounts/.patch.description
Patch a list of provider account objects.

# paths./api/circuits/provider-accounts/.delete.description
Delete a list of provider account objects.

# paths./api/circuits/provider-accounts/{id}/.get.parameters[].description
A unique integer value identifying this provider account.

# paths./api/circuits/provider-accounts/{id}/.put.parameters[].description
A unique integer value identifying this provider account.

# paths./api/circuits/provider-accounts/{id}/.patch.parameters[].description
A unique integer value identifying this provider account.

# paths./api/circuits/provider-accounts/{id}/.delete.parameters[].description
A unique integer value identifying this provider account.

# paths./api/circuits/provider-networks/.get.parameters[].description
The initial index from which to return the results.

# paths./api/circuits/provider-networks/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/circuits/provider-networks/.post.description
Post a list of provider network objects.

# paths./api/circuits/provider-networks/.patch.description
Patch a list of provider network objects.

# paths./api/circuits/provider-networks/.delete.description
Delete a list of provider network objects.

# paths./api/circuits/provider-networks/{id}/.get.parameters[].description
A unique integer value identifying this provider network.

# paths./api/circuits/provider-networks/{id}/.put.parameters[].description
A unique integer value identifying this provider network.

# paths./api/circuits/provider-networks/{id}/.patch.parameters[].description
A unique integer value identifying this provider network.

# paths./api/circuits/provider-networks/{id}/.delete.parameters[].description
A unique integer value identifying this provider network.

# paths./api/circuits/providers/.get.parameters[].description
The initial index from which to return the results.

# paths./api/circuits/providers/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/circuits/providers/{id}/.get.parameters[].description
A unique integer value identifying this provider.

# paths./api/circuits/providers/{id}/.put.parameters[].description
A unique integer value identifying this provider.

# paths./api/circuits/providers/{id}/.patch.parameters[].description
A unique integer value identifying this provider.

# paths./api/circuits/providers/{id}/.delete.parameters[].description
A unique integer value identifying this provider.

# paths./api/circuits/virtual-circuit-terminations/.get.description
Get a list of virtual circuit termination objects.

# paths./api/circuits/virtual-circuit-terminations/.get.parameters[].description
The initial index from which to return the results.

# paths./api/circuits/virtual-circuit-terminations/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/circuits/virtual-circuit-terminations/.post.description
Post a list of virtual circuit termination objects.

# paths./api/circuits/virtual-circuit-terminations/.put.description
Put a list of virtual circuit termination objects.

# paths./api/circuits/virtual-circuit-terminations/.patch.description
Patch a list of virtual circuit termination objects.

# paths./api/circuits/virtual-circuit-terminations/.delete.description
Delete a list of virtual circuit termination objects.

# paths./api/circuits/virtual-circuit-terminations/{id}/.get.description
Get a virtual circuit termination object.

# paths./api/circuits/virtual-circuit-terminations/{id}/.get.parameters[].description
A unique integer value identifying this virtual circuit termination.

# paths./api/circuits/virtual-circuit-terminations/{id}/.put.description
Put a virtual circuit termination object.

# paths./api/circuits/virtual-circuit-terminations/{id}/.put.parameters[].description
A unique integer value identifying this virtual circuit termination.

# paths./api/circuits/virtual-circuit-terminations/{id}/.patch.description
Patch a virtual circuit termination object.

# paths./api/circuits/virtual-circuit-terminations/{id}/.patch.parameters[].description
A unique integer value identifying this virtual circuit termination.

# paths./api/circuits/virtual-circuit-terminations/{id}/.delete.description
Delete a virtual circuit termination object.

# paths./api/circuits/virtual-circuit-terminations/{id}/.delete.parameters[].description
A unique integer value identifying this virtual circuit termination.

# paths./api/circuits/virtual-circuit-terminations/{id}/paths/.get.description
Return all CablePaths which traverse a given pass-through port.

# paths./api/circuits/virtual-circuit-terminations/{id}/paths/.get.parameters[].description
A unique integer value identifying this virtual circuit termination.

# paths./api/circuits/virtual-circuit-types/.get.description
Get a list of virtual circuit type objects.

# paths./api/circuits/virtual-circuit-types/.get.parameters[].description
The initial index from which to return the results.

# paths./api/circuits/virtual-circuit-types/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/circuits/virtual-circuit-types/.post.description
Post a list of virtual circuit type objects.

# paths./api/circuits/virtual-circuit-types/.put.description
Put a list of virtual circuit type objects.

# paths./api/circuits/virtual-circuit-types/.patch.description
Patch a list of virtual circuit type objects.

# paths./api/circuits/virtual-circuit-types/.delete.description
Delete a list of virtual circuit type objects.

# paths./api/circuits/virtual-circuit-types/{id}/.get.parameters[].description
A unique integer value identifying this virtual circuit type.

# paths./api/circuits/virtual-circuit-types/{id}/.put.parameters[].description
A unique integer value identifying this virtual circuit type.

# paths./api/circuits/virtual-circuit-types/{id}/.patch.parameters[].description
A unique integer value identifying this virtual circuit type.

# paths./api/circuits/virtual-circuit-types/{id}/.delete.parameters[].description
A unique integer value identifying this virtual circuit type.

# paths./api/circuits/virtual-circuits/.get.parameters[].description
The initial index from which to return the results.

# paths./api/circuits/virtual-circuits/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/circuits/virtual-circuits/.patch.description
Patch a list of virtual circuit objects.

# paths./api/circuits/virtual-circuits/.delete.description
Delete a list of virtual circuit objects.

# paths./api/circuits/virtual-circuits/{id}/.get.parameters[].description
A unique integer value identifying this virtual circuit.

# paths./api/circuits/virtual-circuits/{id}/.put.parameters[].description
A unique integer value identifying this virtual circuit.

# paths./api/circuits/virtual-circuits/{id}/.patch.parameters[].description
A unique integer value identifying this virtual circuit.

# paths./api/circuits/virtual-circuits/{id}/.delete.parameters[].description
A unique integer value identifying this virtual circuit.

# paths./api/core/background-queues/.get.description
Retrieve a list of RQ Queues.
Note: Queue names are not URL safe, so not returning a detail view.

# paths./api/core/background-queues/{name}/.get.description
Retrieve a list of RQ Queues.
Note: Queue names are not URL safe, so not returning a detail view.

# paths./api/core/data-files/.get.parameters[].description
The initial index from which to return the results.

# paths./api/core/data-files/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/core/data-files/{id}/.get.parameters[].description
A unique integer value identifying this data file.

# paths./api/core/data-sources/.get.parameters[].description
The initial index from which to return the results.

# paths./api/core/data-sources/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/core/data-sources/{id}/.get.parameters[].description
A unique integer value identifying this data source.

# paths./api/core/data-sources/{id}/.put.parameters[].description
A unique integer value identifying this data source.

# paths./api/core/data-sources/{id}/.patch.parameters[].description
A unique integer value identifying this data source.

# paths./api/core/data-sources/{id}/.delete.parameters[].description
A unique integer value identifying this data source.

# paths./api/core/data-sources/{id}/sync/.post.description
Enqueue a job to synchronize the DataSource.

# paths./api/core/data-sources/{id}/sync/.post.parameters[].description
A unique integer value identifying this data source.

# paths./api/core/jobs/.get.parameters[].description
The initial index from which to return the results.

# paths./api/core/jobs/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/core/jobs/{id}/.get.parameters[].description
A unique integer value identifying this job.

# paths./api/core/object-changes/.get.parameters[].description
* `create` - Created
* `update` - Updated
* `delete` - Deleted

# paths./api/core/object-changes/.get.parameters[].description
* `create` - Created
* `update` - Updated
* `delete` - Deleted

# paths./api/core/object-changes/.get.parameters[].description
The initial index from which to return the results.

# paths./api/core/object-changes/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/core/object-changes/{id}/.get.parameters[].description
A unique integer value identifying this object change.

# paths./api/core/object-types/.get.parameters[].description
The initial index from which to return the results.

# paths./api/core/object-types/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/core/object-types/{id}/.get.parameters[].description
A unique integer value identifying this object type.

# paths./api/dcim/cable-terminations/.get.description
Get a list of cable termination objects.

# paths./api/dcim/cable-terminations/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/cable-terminations/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/cable-terminations/{id}/.get.parameters[].description
A unique integer value identifying this cable termination.

# paths./api/dcim/cables/.get.parameters[].description
* `km` - Kilometers
* `m` - Meters
* `cm` - Centimeters
* `mi` - Miles
* `ft` - Feet
* `in` - Inches

# paths./api/dcim/cables/.get.parameters[].description
* `km` - Kilometers
* `m` - Meters
* `cm` - Centimeters
* `mi` - Miles
* `ft` - Feet
* `in` - Inches

# paths./api/dcim/cables/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/cables/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/cables/{id}/.get.parameters[].description
A unique integer value identifying this cable.

# paths./api/dcim/cables/{id}/.put.parameters[].description
A unique integer value identifying this cable.

# paths./api/dcim/cables/{id}/.patch.parameters[].description
A unique integer value identifying this cable.

# paths./api/dcim/cables/{id}/.delete.parameters[].description
A unique integer value identifying this cable.

# paths./api/dcim/connected-device/.get.description
This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer
interface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors
via a protocol such as LLDP. Two query parameters must be included in the request:

* `peer_device`: The name of the peer device
* `peer_interface`: The name of the peer interface

# paths./api/dcim/console-port-templates/.get.description
Get a list of console port template objects.

# paths./api/dcim/console-port-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/console-port-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/console-port-templates/.post.description
Post a list of console port template objects.

# paths./api/dcim/console-port-templates/.put.description
Put a list of console port template objects.

# paths./api/dcim/console-port-templates/.patch.description
Patch a list of console port template objects.

# paths./api/dcim/console-port-templates/.delete.description
Delete a list of console port template objects.

# paths./api/dcim/console-port-templates/{id}/.get.parameters[].description
A unique integer value identifying this console port template.

# paths./api/dcim/console-port-templates/{id}/.put.parameters[].description
A unique integer value identifying this console port template.

# paths./api/dcim/console-port-templates/{id}/.patch.parameters[].description
A unique integer value identifying this console port template.

# paths./api/dcim/console-port-templates/{id}/.delete.parameters[].description
A unique integer value identifying this console port template.

# paths./api/dcim/console-ports/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/console-ports/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/console-ports/{id}/.get.parameters[].description
A unique integer value identifying this console port.

# paths./api/dcim/console-ports/{id}/.put.parameters[].description
A unique integer value identifying this console port.

# paths./api/dcim/console-ports/{id}/.patch.parameters[].description
A unique integer value identifying this console port.

# paths./api/dcim/console-ports/{id}/.delete.parameters[].description
A unique integer value identifying this console port.

# paths./api/dcim/console-ports/{id}/trace/.get.description
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).

# paths./api/dcim/console-ports/{id}/trace/.get.parameters[].description
A unique integer value identifying this console port.

# paths./api/dcim/console-server-port-templates/.get.description
Get a list of console server port template objects.

# paths./api/dcim/console-server-port-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/console-server-port-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/console-server-port-templates/.post.description
Post a list of console server port template objects.

# paths./api/dcim/console-server-port-templates/.put.description
Put a list of console server port template objects.

# paths./api/dcim/console-server-port-templates/.patch.description
Patch a list of console server port template objects.

# paths./api/dcim/console-server-port-templates/.delete.description
Delete a list of console server port template objects.

# paths./api/dcim/console-server-port-templates/{id}/.get.description
Get a console server port template object.

# paths./api/dcim/console-server-port-templates/{id}/.get.parameters[].description
A unique integer value identifying this console server port template.

# paths./api/dcim/console-server-port-templates/{id}/.put.description
Put a console server port template object.

# paths./api/dcim/console-server-port-templates/{id}/.put.parameters[].description
A unique integer value identifying this console server port template.

# paths./api/dcim/console-server-port-templates/{id}/.patch.description
Patch a console server port template object.

# paths./api/dcim/console-server-port-templates/{id}/.patch.parameters[].description
A unique integer value identifying this console server port template.

# paths./api/dcim/console-server-port-templates/{id}/.delete.description
Delete a console server port template object.

# paths./api/dcim/console-server-port-templates/{id}/.delete.parameters[].description
A unique integer value identifying this console server port template.

# paths./api/dcim/console-server-ports/.get.description
Get a list of console server port objects.

# paths./api/dcim/console-server-ports/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/console-server-ports/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/console-server-ports/.post.description
Post a list of console server port objects.

# paths./api/dcim/console-server-ports/.put.description
Put a list of console server port objects.

# paths./api/dcim/console-server-ports/.patch.description
Patch a list of console server port objects.

# paths./api/dcim/console-server-ports/.delete.description
Delete a list of console server port objects.

# paths./api/dcim/console-server-ports/{id}/.get.parameters[].description
A unique integer value identifying this console server port.

# paths./api/dcim/console-server-ports/{id}/.put.parameters[].description
A unique integer value identifying this console server port.

# paths./api/dcim/console-server-ports/{id}/.patch.parameters[].description
A unique integer value identifying this console server port.

# paths./api/dcim/console-server-ports/{id}/.delete.parameters[].description
A unique integer value identifying this console server port.

# paths./api/dcim/console-server-ports/{id}/trace/.get.description
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).

# paths./api/dcim/console-server-ports/{id}/trace/.get.parameters[].description
A unique integer value identifying this console server port.

# paths./api/dcim/device-bay-templates/.get.description
Get a list of device bay template objects.

# paths./api/dcim/device-bay-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/device-bay-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/device-bay-templates/.post.description
Post a list of device bay template objects.

# paths./api/dcim/device-bay-templates/.put.description
Put a list of device bay template objects.

# paths./api/dcim/device-bay-templates/.patch.description
Patch a list of device bay template objects.

# paths./api/dcim/device-bay-templates/.delete.description
Delete a list of device bay template objects.

# paths./api/dcim/device-bay-templates/{id}/.get.parameters[].description
A unique integer value identifying this device bay template.

# paths./api/dcim/device-bay-templates/{id}/.put.parameters[].description
A unique integer value identifying this device bay template.

# paths./api/dcim/device-bay-templates/{id}/.patch.parameters[].description
A unique integer value identifying this device bay template.

# paths./api/dcim/device-bay-templates/{id}/.delete.parameters[].description
A unique integer value identifying this device bay template.

# paths./api/dcim/device-bays/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/device-bays/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/device-bays/{id}/.get.parameters[].description
A unique integer value identifying this device bay.

# paths./api/dcim/device-bays/{id}/.put.parameters[].description
A unique integer value identifying this device bay.

# paths./api/dcim/device-bays/{id}/.patch.parameters[].description
A unique integer value identifying this device bay.

# paths./api/dcim/device-bays/{id}/.delete.parameters[].description
A unique integer value identifying this device bay.

# paths./api/dcim/device-roles/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/device-roles/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/device-roles/{id}/.get.parameters[].description
A unique integer value identifying this device role.

# paths./api/dcim/device-roles/{id}/.put.parameters[].description
A unique integer value identifying this device role.

# paths./api/dcim/device-roles/{id}/.patch.parameters[].description
A unique integer value identifying this device role.

# paths./api/dcim/device-roles/{id}/.delete.parameters[].description
A unique integer value identifying this device role.

# paths./api/dcim/device-types/.get.parameters[].description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# paths./api/dcim/device-types/.get.parameters[].description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# paths./api/dcim/device-types/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/device-types/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/device-types/.get.parameters[].description
Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.

* `parent` - Parent
* `child` - Child

# paths./api/dcim/device-types/.get.parameters[].description
Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.

* `parent` - Parent
* `child` - Child

# paths./api/dcim/device-types/.get.parameters[].description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# paths./api/dcim/device-types/.get.parameters[].description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# paths./api/dcim/device-types/{id}/.get.parameters[].description
A unique integer value identifying this device type.

# paths./api/dcim/device-types/{id}/.put.parameters[].description
A unique integer value identifying this device type.

# paths./api/dcim/device-types/{id}/.patch.parameters[].description
A unique integer value identifying this device type.

# paths./api/dcim/device-types/{id}/.delete.parameters[].description
A unique integer value identifying this device type.

# paths./api/dcim/devices/.get.parameters[].description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# paths./api/dcim/devices/.get.parameters[].description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# paths./api/dcim/devices/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/devices/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/devices/{id}/.get.parameters[].description
A unique integer value identifying this device.

# paths./api/dcim/devices/{id}/.put.parameters[].description
A unique integer value identifying this device.

# paths./api/dcim/devices/{id}/.patch.parameters[].description
A unique integer value identifying this device.

# paths./api/dcim/devices/{id}/.delete.parameters[].description
A unique integer value identifying this device.

# paths./api/dcim/devices/{id}/render-config/.post.description
Resolve and render the preferred ConfigTemplate for this Device.

# paths./api/dcim/devices/{id}/render-config/.post.parameters[].description
A unique integer value identifying this device.

# paths./api/dcim/front-port-templates/.get.description
Get a list of front port template objects.

# paths./api/dcim/front-port-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/front-port-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/front-port-templates/.post.description
Post a list of front port template objects.

# paths./api/dcim/front-port-templates/.put.description
Put a list of front port template objects.

# paths./api/dcim/front-port-templates/.patch.description
Patch a list of front port template objects.

# paths./api/dcim/front-port-templates/.delete.description
Delete a list of front port template objects.

# paths./api/dcim/front-port-templates/{id}/.get.parameters[].description
A unique integer value identifying this front port template.

# paths./api/dcim/front-port-templates/{id}/.put.parameters[].description
A unique integer value identifying this front port template.

# paths./api/dcim/front-port-templates/{id}/.patch.parameters[].description
A unique integer value identifying this front port template.

# paths./api/dcim/front-port-templates/{id}/.delete.parameters[].description
A unique integer value identifying this front port template.

# paths./api/dcim/front-ports/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/front-ports/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/front-ports/{id}/.get.parameters[].description
A unique integer value identifying this front port.

# paths./api/dcim/front-ports/{id}/.put.parameters[].description
A unique integer value identifying this front port.

# paths./api/dcim/front-ports/{id}/.patch.parameters[].description
A unique integer value identifying this front port.

# paths./api/dcim/front-ports/{id}/.delete.parameters[].description
A unique integer value identifying this front port.

# paths./api/dcim/front-ports/{id}/paths/.get.description
Return all CablePaths which traverse a given pass-through port.

# paths./api/dcim/front-ports/{id}/paths/.get.parameters[].description
A unique integer value identifying this front port.

# paths./api/dcim/interface-templates/.get.description
Get a list of interface template objects.

# paths./api/dcim/interface-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/interface-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/interface-templates/.post.description
Post a list of interface template objects.

# paths./api/dcim/interface-templates/.put.description
Put a list of interface template objects.

# paths./api/dcim/interface-templates/.patch.description
Patch a list of interface template objects.

# paths./api/dcim/interface-templates/.delete.description
Delete a list of interface template objects.

# paths./api/dcim/interface-templates/{id}/.get.parameters[].description
A unique integer value identifying this interface template.

# paths./api/dcim/interface-templates/{id}/.put.parameters[].description
A unique integer value identifying this interface template.

# paths./api/dcim/interface-templates/{id}/.patch.parameters[].description
A unique integer value identifying this interface template.

# paths./api/dcim/interface-templates/{id}/.delete.parameters[].description
A unique integer value identifying this interface template.

# paths./api/dcim/interfaces/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/interfaces/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/interfaces/{id}/.get.parameters[].description
A unique integer value identifying this interface.

# paths./api/dcim/interfaces/{id}/.put.parameters[].description
A unique integer value identifying this interface.

# paths./api/dcim/interfaces/{id}/.patch.parameters[].description
A unique integer value identifying this interface.

# paths./api/dcim/interfaces/{id}/.delete.parameters[].description
A unique integer value identifying this interface.

# paths./api/dcim/interfaces/{id}/trace/.get.description
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).

# paths./api/dcim/interfaces/{id}/trace/.get.parameters[].description
A unique integer value identifying this interface.

# paths./api/dcim/inventory-item-roles/.get.description
Get a list of inventory item role objects.

# paths./api/dcim/inventory-item-roles/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/inventory-item-roles/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/inventory-item-roles/.post.description
Post a list of inventory item role objects.

# paths./api/dcim/inventory-item-roles/.put.description
Put a list of inventory item role objects.

# paths./api/dcim/inventory-item-roles/.patch.description
Patch a list of inventory item role objects.

# paths./api/dcim/inventory-item-roles/.delete.description
Delete a list of inventory item role objects.

# paths./api/dcim/inventory-item-roles/{id}/.get.parameters[].description
A unique integer value identifying this inventory item role.

# paths./api/dcim/inventory-item-roles/{id}/.put.parameters[].description
A unique integer value identifying this inventory item role.

# paths./api/dcim/inventory-item-roles/{id}/.patch.parameters[].description
A unique integer value identifying this inventory item role.

# paths./api/dcim/inventory-item-roles/{id}/.delete.parameters[].description
A unique integer value identifying this inventory item role.

# paths./api/dcim/inventory-item-templates/.get.description
Get a list of inventory item template objects.

# paths./api/dcim/inventory-item-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/inventory-item-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/inventory-item-templates/.post.description
Post a list of inventory item template objects.

# paths./api/dcim/inventory-item-templates/.put.description
Put a list of inventory item template objects.

# paths./api/dcim/inventory-item-templates/.patch.description
Patch a list of inventory item template objects.

# paths./api/dcim/inventory-item-templates/.delete.description
Delete a list of inventory item template objects.

# paths./api/dcim/inventory-item-templates/{id}/.get.parameters[].description
A unique integer value identifying this inventory item template.

# paths./api/dcim/inventory-item-templates/{id}/.put.parameters[].description
A unique integer value identifying this inventory item template.

# paths./api/dcim/inventory-item-templates/{id}/.patch.parameters[].description
A unique integer value identifying this inventory item template.

# paths./api/dcim/inventory-item-templates/{id}/.delete.description
Delete a inventory item template object.

# paths./api/dcim/inventory-item-templates/{id}/.delete.parameters[].description
A unique integer value identifying this inventory item template.

# paths./api/dcim/inventory-items/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/inventory-items/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/inventory-items/.delete.description
Delete a list of inventory item objects.

# paths./api/dcim/inventory-items/{id}/.get.parameters[].description
A unique integer value identifying this inventory item.

# paths./api/dcim/inventory-items/{id}/.put.parameters[].description
A unique integer value identifying this inventory item.

# paths./api/dcim/inventory-items/{id}/.patch.parameters[].description
A unique integer value identifying this inventory item.

# paths./api/dcim/inventory-items/{id}/.delete.parameters[].description
A unique integer value identifying this inventory item.

# paths./api/dcim/locations/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/locations/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/locations/{id}/.get.parameters[].description
A unique integer value identifying this location.

# paths./api/dcim/locations/{id}/.put.parameters[].description
A unique integer value identifying this location.

# paths./api/dcim/locations/{id}/.patch.parameters[].description
A unique integer value identifying this location.

# paths./api/dcim/locations/{id}/.delete.parameters[].description
A unique integer value identifying this location.

# paths./api/dcim/mac-addresses/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/mac-addresses/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/mac-addresses/{id}/.get.parameters[].description
A unique integer value identifying this MAC address.

# paths./api/dcim/mac-addresses/{id}/.put.parameters[].description
A unique integer value identifying this MAC address.

# paths./api/dcim/mac-addresses/{id}/.patch.parameters[].description
A unique integer value identifying this MAC address.

# paths./api/dcim/mac-addresses/{id}/.delete.parameters[].description
A unique integer value identifying this MAC address.

# paths./api/dcim/manufacturers/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/manufacturers/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/manufacturers/{id}/.get.parameters[].description
A unique integer value identifying this manufacturer.

# paths./api/dcim/manufacturers/{id}/.put.parameters[].description
A unique integer value identifying this manufacturer.

# paths./api/dcim/manufacturers/{id}/.patch.parameters[].description
A unique integer value identifying this manufacturer.

# paths./api/dcim/manufacturers/{id}/.delete.parameters[].description
A unique integer value identifying this manufacturer.

# paths./api/dcim/module-bay-templates/.get.description
Get a list of module bay template objects.

# paths./api/dcim/module-bay-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/module-bay-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/module-bay-templates/.post.description
Post a list of module bay template objects.

# paths./api/dcim/module-bay-templates/.put.description
Put a list of module bay template objects.

# paths./api/dcim/module-bay-templates/.patch.description
Patch a list of module bay template objects.

# paths./api/dcim/module-bay-templates/.delete.description
Delete a list of module bay template objects.

# paths./api/dcim/module-bay-templates/{id}/.get.parameters[].description
A unique integer value identifying this module bay template.

# paths./api/dcim/module-bay-templates/{id}/.put.parameters[].description
A unique integer value identifying this module bay template.

# paths./api/dcim/module-bay-templates/{id}/.patch.parameters[].description
A unique integer value identifying this module bay template.

# paths./api/dcim/module-bay-templates/{id}/.delete.parameters[].description
A unique integer value identifying this module bay template.

# paths./api/dcim/module-bays/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/module-bays/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/module-bays/{id}/.get.parameters[].description
A unique integer value identifying this module bay.

# paths./api/dcim/module-bays/{id}/.put.parameters[].description
A unique integer value identifying this module bay.

# paths./api/dcim/module-bays/{id}/.patch.parameters[].description
A unique integer value identifying this module bay.

# paths./api/dcim/module-bays/{id}/.delete.parameters[].description
A unique integer value identifying this module bay.

# paths./api/dcim/module-type-profiles/.get.description
Get a list of module type profile objects.

# paths./api/dcim/module-type-profiles/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/module-type-profiles/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/module-type-profiles/.post.description
Post a list of module type profile objects.

# paths./api/dcim/module-type-profiles/.put.description
Put a list of module type profile objects.

# paths./api/dcim/module-type-profiles/.patch.description
Patch a list of module type profile objects.

# paths./api/dcim/module-type-profiles/.delete.description
Delete a list of module type profile objects.

# paths./api/dcim/module-type-profiles/{id}/.get.parameters[].description
A unique integer value identifying this module type profile.

# paths./api/dcim/module-type-profiles/{id}/.put.parameters[].description
A unique integer value identifying this module type profile.

# paths./api/dcim/module-type-profiles/{id}/.patch.parameters[].description
A unique integer value identifying this module type profile.

# paths./api/dcim/module-type-profiles/{id}/.delete.parameters[].description
A unique integer value identifying this module type profile.

# paths./api/dcim/module-types/.get.parameters[].description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `passive` - Passive

# paths./api/dcim/module-types/.get.parameters[].description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `passive` - Passive

# paths./api/dcim/module-types/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/module-types/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/module-types/.get.parameters[].description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# paths./api/dcim/module-types/.get.parameters[].description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# paths./api/dcim/module-types/{id}/.get.parameters[].description
A unique integer value identifying this module type.

# paths./api/dcim/module-types/{id}/.put.parameters[].description
A unique integer value identifying this module type.

# paths./api/dcim/module-types/{id}/.patch.parameters[].description
A unique integer value identifying this module type.

# paths./api/dcim/module-types/{id}/.delete.parameters[].description
A unique integer value identifying this module type.

# paths./api/dcim/modules/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/modules/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/modules/{id}/.get.parameters[].description
A unique integer value identifying this module.

# paths./api/dcim/modules/{id}/.put.parameters[].description
A unique integer value identifying this module.

# paths./api/dcim/modules/{id}/.patch.parameters[].description
A unique integer value identifying this module.

# paths./api/dcim/modules/{id}/.delete.parameters[].description
A unique integer value identifying this module.

# paths./api/dcim/platforms/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/platforms/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/platforms/{id}/.get.parameters[].description
A unique integer value identifying this platform.

# paths./api/dcim/platforms/{id}/.put.parameters[].description
A unique integer value identifying this platform.

# paths./api/dcim/platforms/{id}/.patch.parameters[].description
A unique integer value identifying this platform.

# paths./api/dcim/platforms/{id}/.delete.parameters[].description
A unique integer value identifying this platform.

# paths./api/dcim/power-feeds/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/power-feeds/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/power-feeds/.get.parameters[].description
* `single-phase` - Single phase
* `three-phase` - Three-phase

# paths./api/dcim/power-feeds/.get.parameters[].description
* `single-phase` - Single phase
* `three-phase` - Three-phase

# paths./api/dcim/power-feeds/.get.parameters[].description
* `primary` - Primary
* `redundant` - Redundant

# paths./api/dcim/power-feeds/.get.parameters[].description
* `primary` - Primary
* `redundant` - Redundant

# paths./api/dcim/power-feeds/{id}/.get.parameters[].description
A unique integer value identifying this power feed.

# paths./api/dcim/power-feeds/{id}/.put.parameters[].description
A unique integer value identifying this power feed.

# paths./api/dcim/power-feeds/{id}/.patch.parameters[].description
A unique integer value identifying this power feed.

# paths./api/dcim/power-feeds/{id}/.delete.parameters[].description
A unique integer value identifying this power feed.

# paths./api/dcim/power-feeds/{id}/trace/.get.description
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).

# paths./api/dcim/power-feeds/{id}/trace/.get.parameters[].description
A unique integer value identifying this power feed.

# paths./api/dcim/power-outlet-templates/.get.description
Get a list of power outlet template objects.

# paths./api/dcim/power-outlet-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/power-outlet-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/power-outlet-templates/.post.description
Post a list of power outlet template objects.

# paths./api/dcim/power-outlet-templates/.put.description
Put a list of power outlet template objects.

# paths./api/dcim/power-outlet-templates/.patch.description
Patch a list of power outlet template objects.

# paths./api/dcim/power-outlet-templates/.delete.description
Delete a list of power outlet template objects.

# paths./api/dcim/power-outlet-templates/{id}/.get.parameters[].description
A unique integer value identifying this power outlet template.

# paths./api/dcim/power-outlet-templates/{id}/.put.parameters[].description
A unique integer value identifying this power outlet template.

# paths./api/dcim/power-outlet-templates/{id}/.patch.parameters[].description
A unique integer value identifying this power outlet template.

# paths./api/dcim/power-outlet-templates/{id}/.delete.parameters[].description
A unique integer value identifying this power outlet template.

# paths./api/dcim/power-outlets/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/power-outlets/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/power-outlets/{id}/.get.parameters[].description
A unique integer value identifying this power outlet.

# paths./api/dcim/power-outlets/{id}/.put.parameters[].description
A unique integer value identifying this power outlet.

# paths./api/dcim/power-outlets/{id}/.patch.parameters[].description
A unique integer value identifying this power outlet.

# paths./api/dcim/power-outlets/{id}/.delete.parameters[].description
A unique integer value identifying this power outlet.

# paths./api/dcim/power-outlets/{id}/trace/.get.description
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).

# paths./api/dcim/power-outlets/{id}/trace/.get.parameters[].description
A unique integer value identifying this power outlet.

# paths./api/dcim/power-panels/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/power-panels/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/power-panels/{id}/.get.parameters[].description
A unique integer value identifying this power panel.

# paths./api/dcim/power-panels/{id}/.put.parameters[].description
A unique integer value identifying this power panel.

# paths./api/dcim/power-panels/{id}/.patch.parameters[].description
A unique integer value identifying this power panel.

# paths./api/dcim/power-panels/{id}/.delete.parameters[].description
A unique integer value identifying this power panel.

# paths./api/dcim/power-port-templates/.get.description
Get a list of power port template objects.

# paths./api/dcim/power-port-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/power-port-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/power-port-templates/.post.description
Post a list of power port template objects.

# paths./api/dcim/power-port-templates/.put.description
Put a list of power port template objects.

# paths./api/dcim/power-port-templates/.patch.description
Patch a list of power port template objects.

# paths./api/dcim/power-port-templates/.delete.description
Delete a list of power port template objects.

# paths./api/dcim/power-port-templates/{id}/.get.parameters[].description
A unique integer value identifying this power port template.

# paths./api/dcim/power-port-templates/{id}/.put.parameters[].description
A unique integer value identifying this power port template.

# paths./api/dcim/power-port-templates/{id}/.patch.parameters[].description
A unique integer value identifying this power port template.

# paths./api/dcim/power-port-templates/{id}/.delete.parameters[].description
A unique integer value identifying this power port template.

# paths./api/dcim/power-ports/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/power-ports/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/power-ports/{id}/.get.parameters[].description
A unique integer value identifying this power port.

# paths./api/dcim/power-ports/{id}/.put.parameters[].description
A unique integer value identifying this power port.

# paths./api/dcim/power-ports/{id}/.patch.parameters[].description
A unique integer value identifying this power port.

# paths./api/dcim/power-ports/{id}/.delete.parameters[].description
A unique integer value identifying this power port.

# paths./api/dcim/power-ports/{id}/trace/.get.description
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).

# paths./api/dcim/power-ports/{id}/trace/.get.parameters[].description
A unique integer value identifying this power port.

# paths./api/dcim/rack-reservations/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/rack-reservations/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/rack-reservations/.post.description
Post a list of rack reservation objects.

# paths./api/dcim/rack-reservations/.patch.description
Patch a list of rack reservation objects.

# paths./api/dcim/rack-reservations/.delete.description
Delete a list of rack reservation objects.

# paths./api/dcim/rack-reservations/{id}/.get.parameters[].description
A unique integer value identifying this rack reservation.

# paths./api/dcim/rack-reservations/{id}/.put.parameters[].description
A unique integer value identifying this rack reservation.

# paths./api/dcim/rack-reservations/{id}/.patch.parameters[].description
A unique integer value identifying this rack reservation.

# paths./api/dcim/rack-reservations/{id}/.delete.parameters[].description
A unique integer value identifying this rack reservation.

# paths./api/dcim/rack-roles/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/rack-roles/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/rack-roles/{id}/.get.parameters[].description
A unique integer value identifying this rack role.

# paths./api/dcim/rack-roles/{id}/.put.parameters[].description
A unique integer value identifying this rack role.

# paths./api/dcim/rack-roles/{id}/.patch.parameters[].description
A unique integer value identifying this rack role.

# paths./api/dcim/rack-roles/{id}/.delete.parameters[].description
A unique integer value identifying this rack role.

# paths./api/dcim/rack-types/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/rack-types/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/rack-types/.get.parameters[].description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# paths./api/dcim/rack-types/.get.parameters[].description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# paths./api/dcim/rack-types/{id}/.get.parameters[].description
A unique integer value identifying this rack type.

# paths./api/dcim/rack-types/{id}/.put.parameters[].description
A unique integer value identifying this rack type.

# paths./api/dcim/rack-types/{id}/.patch.parameters[].description
A unique integer value identifying this rack type.

# paths./api/dcim/rack-types/{id}/.delete.parameters[].description
A unique integer value identifying this rack type.

# paths./api/dcim/racks/.get.parameters[].description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front

# paths./api/dcim/racks/.get.parameters[].description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front

# paths./api/dcim/racks/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/racks/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/racks/.get.parameters[].description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# paths./api/dcim/racks/.get.parameters[].description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# paths./api/dcim/racks/{id}/.get.parameters[].description
A unique integer value identifying this rack.

# paths./api/dcim/racks/{id}/.put.parameters[].description
A unique integer value identifying this rack.

# paths./api/dcim/racks/{id}/.patch.parameters[].description
A unique integer value identifying this rack.

# paths./api/dcim/racks/{id}/.delete.parameters[].description
A unique integer value identifying this rack.

# paths./api/dcim/racks/{id}/elevation/.get.description
Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.

# paths./api/dcim/racks/{id}/elevation/.get.parameters[].description
A unique integer value identifying this rack.

# paths./api/dcim/racks/{id}/elevation/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/rear-port-templates/.get.description
Get a list of rear port template objects.

# paths./api/dcim/rear-port-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/rear-port-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/rear-port-templates/.post.description
Post a list of rear port template objects.

# paths./api/dcim/rear-port-templates/.put.description
Put a list of rear port template objects.

# paths./api/dcim/rear-port-templates/.patch.description
Patch a list of rear port template objects.

# paths./api/dcim/rear-port-templates/.delete.description
Delete a list of rear port template objects.

# paths./api/dcim/rear-port-templates/{id}/.get.parameters[].description
A unique integer value identifying this rear port template.

# paths./api/dcim/rear-port-templates/{id}/.put.parameters[].description
A unique integer value identifying this rear port template.

# paths./api/dcim/rear-port-templates/{id}/.patch.parameters[].description
A unique integer value identifying this rear port template.

# paths./api/dcim/rear-port-templates/{id}/.delete.parameters[].description
A unique integer value identifying this rear port template.

# paths./api/dcim/rear-ports/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/rear-ports/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/rear-ports/{id}/.get.parameters[].description
A unique integer value identifying this rear port.

# paths./api/dcim/rear-ports/{id}/.put.parameters[].description
A unique integer value identifying this rear port.

# paths./api/dcim/rear-ports/{id}/.patch.parameters[].description
A unique integer value identifying this rear port.

# paths./api/dcim/rear-ports/{id}/.delete.parameters[].description
A unique integer value identifying this rear port.

# paths./api/dcim/rear-ports/{id}/paths/.get.description
Return all CablePaths which traverse a given pass-through port.

# paths./api/dcim/rear-ports/{id}/paths/.get.parameters[].description
A unique integer value identifying this rear port.

# paths./api/dcim/regions/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/regions/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/regions/{id}/.get.parameters[].description
A unique integer value identifying this region.

# paths./api/dcim/regions/{id}/.put.parameters[].description
A unique integer value identifying this region.

# paths./api/dcim/regions/{id}/.patch.parameters[].description
A unique integer value identifying this region.

# paths./api/dcim/regions/{id}/.delete.parameters[].description
A unique integer value identifying this region.

# paths./api/dcim/site-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/site-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/site-groups/{id}/.get.parameters[].description
A unique integer value identifying this site group.

# paths./api/dcim/site-groups/{id}/.put.parameters[].description
A unique integer value identifying this site group.

# paths./api/dcim/site-groups/{id}/.patch.parameters[].description
A unique integer value identifying this site group.

# paths./api/dcim/site-groups/{id}/.delete.parameters[].description
A unique integer value identifying this site group.

# paths./api/dcim/sites/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/sites/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/sites/{id}/.get.parameters[].description
A unique integer value identifying this site.

# paths./api/dcim/sites/{id}/.put.parameters[].description
A unique integer value identifying this site.

# paths./api/dcim/sites/{id}/.patch.parameters[].description
A unique integer value identifying this site.

# paths./api/dcim/sites/{id}/.delete.parameters[].description
A unique integer value identifying this site.

# paths./api/dcim/virtual-chassis/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/virtual-chassis/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/virtual-chassis/.patch.description
Patch a list of virtual chassis objects.

# paths./api/dcim/virtual-chassis/.delete.description
Delete a list of virtual chassis objects.

# paths./api/dcim/virtual-chassis/{id}/.get.parameters[].description
A unique integer value identifying this virtual chassis.

# paths./api/dcim/virtual-chassis/{id}/.put.parameters[].description
A unique integer value identifying this virtual chassis.

# paths./api/dcim/virtual-chassis/{id}/.patch.parameters[].description
A unique integer value identifying this virtual chassis.

# paths./api/dcim/virtual-chassis/{id}/.delete.parameters[].description
A unique integer value identifying this virtual chassis.

# paths./api/dcim/virtual-device-contexts/.get.description
Get a list of virtual device context objects.

# paths./api/dcim/virtual-device-contexts/.get.parameters[].description
The initial index from which to return the results.

# paths./api/dcim/virtual-device-contexts/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/dcim/virtual-device-contexts/.post.description
Post a list of virtual device context objects.

# paths./api/dcim/virtual-device-contexts/.put.description
Put a list of virtual device context objects.

# paths./api/dcim/virtual-device-contexts/.patch.description
Patch a list of virtual device context objects.

# paths./api/dcim/virtual-device-contexts/.delete.description
Delete a list of virtual device context objects.

# paths./api/dcim/virtual-device-contexts/{id}/.get.parameters[].description
A unique integer value identifying this virtual device context.

# paths./api/dcim/virtual-device-contexts/{id}/.put.parameters[].description
A unique integer value identifying this virtual device context.

# paths./api/dcim/virtual-device-contexts/{id}/.patch.parameters[].description
A unique integer value identifying this virtual device context.

# paths./api/dcim/virtual-device-contexts/{id}/.delete.parameters[].description
A unique integer value identifying this virtual device context.

# paths./api/extras/bookmarks/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/bookmarks/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/bookmarks/{id}/.get.parameters[].description
A unique integer value identifying this bookmark.

# paths./api/extras/bookmarks/{id}/.put.parameters[].description
A unique integer value identifying this bookmark.

# paths./api/extras/bookmarks/{id}/.patch.parameters[].description
A unique integer value identifying this bookmark.

# paths./api/extras/bookmarks/{id}/.delete.parameters[].description
A unique integer value identifying this bookmark.

# paths./api/extras/config-context-profiles/.get.description
Get a list of config context profile objects.

# paths./api/extras/config-context-profiles/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/config-context-profiles/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/config-context-profiles/.post.description
Post a list of config context profile objects.

# paths./api/extras/config-context-profiles/.put.description
Put a list of config context profile objects.

# paths./api/extras/config-context-profiles/.patch.description
Patch a list of config context profile objects.

# paths./api/extras/config-context-profiles/.delete.description
Delete a list of config context profile objects.

# paths./api/extras/config-context-profiles/{id}/.get.parameters[].description
A unique integer value identifying this config context profile.

# paths./api/extras/config-context-profiles/{id}/.put.parameters[].description
A unique integer value identifying this config context profile.

# paths./api/extras/config-context-profiles/{id}/.patch.parameters[].description
A unique integer value identifying this config context profile.

# paths./api/extras/config-context-profiles/{id}/.delete.parameters[].description
A unique integer value identifying this config context profile.

# paths./api/extras/config-context-profiles/{id}/sync/.post.description
Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).

# paths./api/extras/config-context-profiles/{id}/sync/.post.parameters[].description
A unique integer value identifying this config context profile.

# paths./api/extras/config-contexts/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/config-contexts/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/config-contexts/.delete.description
Delete a list of config context objects.

# paths./api/extras/config-contexts/{id}/.get.parameters[].description
A unique integer value identifying this config context.

# paths./api/extras/config-contexts/{id}/.put.parameters[].description
A unique integer value identifying this config context.

# paths./api/extras/config-contexts/{id}/.patch.parameters[].description
A unique integer value identifying this config context.

# paths./api/extras/config-contexts/{id}/.delete.parameters[].description
A unique integer value identifying this config context.

# paths./api/extras/config-contexts/{id}/sync/.post.description
Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).

# paths./api/extras/config-contexts/{id}/sync/.post.parameters[].description
A unique integer value identifying this config context.

# paths./api/extras/config-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/config-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/config-templates/.patch.description
Patch a list of config template objects.

# paths./api/extras/config-templates/.delete.description
Delete a list of config template objects.

# paths./api/extras/config-templates/{id}/.get.parameters[].description
A unique integer value identifying this config template.

# paths./api/extras/config-templates/{id}/.put.parameters[].description
A unique integer value identifying this config template.

# paths./api/extras/config-templates/{id}/.patch.parameters[].description
A unique integer value identifying this config template.

# paths./api/extras/config-templates/{id}/.delete.parameters[].description
A unique integer value identifying this config template.

# paths./api/extras/config-templates/{id}/render/.post.description
Render a ConfigTemplate using the context data provided (if any). If the client requests "text/plain" data,
return the raw rendered content, rather than serialized JSON.

# paths./api/extras/config-templates/{id}/render/.post.parameters[].description
A unique integer value identifying this config template.

# paths./api/extras/config-templates/{id}/sync/.post.description
Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).

# paths./api/extras/config-templates/{id}/sync/.post.parameters[].description
A unique integer value identifying this config template.

# paths./api/extras/custom-field-choice-sets/.get.description
Get a list of custom field choice set objects.

# paths./api/extras/custom-field-choice-sets/.get.parameters[].description
Base set of predefined choices (optional)

* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)

# paths./api/extras/custom-field-choice-sets/.get.parameters[].description
Base set of predefined choices (optional)

* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)

# paths./api/extras/custom-field-choice-sets/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/custom-field-choice-sets/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/custom-field-choice-sets/.post.description
Post a list of custom field choice set objects.

# paths./api/extras/custom-field-choice-sets/.put.description
Put a list of custom field choice set objects.

# paths./api/extras/custom-field-choice-sets/.patch.description
Patch a list of custom field choice set objects.

# paths./api/extras/custom-field-choice-sets/.delete.description
Delete a list of custom field choice set objects.

# paths./api/extras/custom-field-choice-sets/{id}/.get.parameters[].description
A unique integer value identifying this custom field choice set.

# paths./api/extras/custom-field-choice-sets/{id}/.put.parameters[].description
A unique integer value identifying this custom field choice set.

# paths./api/extras/custom-field-choice-sets/{id}/.patch.parameters[].description
A unique integer value identifying this custom field choice set.

# paths./api/extras/custom-field-choice-sets/{id}/.delete.description
Delete a custom field choice set object.

# paths./api/extras/custom-field-choice-sets/{id}/.delete.parameters[].description
A unique integer value identifying this custom field choice set.

# paths./api/extras/custom-field-choice-sets/{id}/choices/.get.description
Provides an endpoint to iterate through each choice in a set.

# paths./api/extras/custom-field-choice-sets/{id}/choices/.get.parameters[].description
A unique integer value identifying this custom field choice set.

# paths./api/extras/custom-fields/.get.parameters[].description
Loose matches any instance of a given string; exact matches the entire field.

* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact

# paths./api/extras/custom-fields/.get.parameters[].description
Loose matches any instance of a given string; exact matches the entire field.

* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact

# paths./api/extras/custom-fields/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/custom-fields/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
The type of data this custom field holds

# paths./api/extras/custom-fields/.get.parameters[].description
Specifies whether the custom field value can be edited in the UI

* `yes` - Yes
* `no` - No
* `hidden` - Hidden

# paths./api/extras/custom-fields/.get.parameters[].description
Specifies whether the custom field value can be edited in the UI

* `yes` - Yes
* `no` - No
* `hidden` - Hidden

# paths./api/extras/custom-fields/.get.parameters[].description
Specifies whether the custom field is displayed in the UI

* `always` - Always
* `if-set` - If set
* `hidden` - Hidden

# paths./api/extras/custom-fields/.get.parameters[].description
Specifies whether the custom field is displayed in the UI

* `always` - Always
* `if-set` - If set
* `hidden` - Hidden

# paths./api/extras/custom-fields/{id}/.get.parameters[].description
A unique integer value identifying this custom field.

# paths./api/extras/custom-fields/{id}/.put.parameters[].description
A unique integer value identifying this custom field.

# paths./api/extras/custom-fields/{id}/.patch.parameters[].description
A unique integer value identifying this custom field.

# paths./api/extras/custom-fields/{id}/.delete.parameters[].description
A unique integer value identifying this custom field.

# paths./api/extras/custom-links/.get.parameters[].description
The class of the first link in a group will be used for the dropdown button

* `default` - Default
* `blue` - Blue
* `indigo` - Indigo
* `purple` - Purple
* `pink` - Pink
* `red` - Red
* `orange` - Orange
* `yellow` - Yellow
* `green` - Green
* `teal` - Teal
* `cyan` - Cyan
* `gray` - Gray
* `black` - Black
* `white` - White
* `ghost-dark` - Link

# paths./api/extras/custom-links/.get.parameters[].description
The class of the first link in a group will be used for the dropdown button

* `default` - Default
* `blue` - Blue
* `indigo` - Indigo
* `purple` - Purple
* `pink` - Pink
* `red` - Red
* `orange` - Orange
* `yellow` - Yellow
* `green` - Green
* `teal` - Teal
* `cyan` - Cyan
* `gray` - Gray
* `black` - Black
* `white` - White
* `ghost-dark` - Link

# paths./api/extras/custom-links/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/custom-links/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/custom-links/{id}/.get.parameters[].description
A unique integer value identifying this custom link.

# paths./api/extras/custom-links/{id}/.put.parameters[].description
A unique integer value identifying this custom link.

# paths./api/extras/custom-links/{id}/.patch.parameters[].description
A unique integer value identifying this custom link.

# paths./api/extras/custom-links/{id}/.delete.parameters[].description
A unique integer value identifying this custom link.

# paths./api/extras/event-rules/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/event-rules/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/event-rules/{id}/.get.parameters[].description
A unique integer value identifying this event rule.

# paths./api/extras/event-rules/{id}/.put.parameters[].description
A unique integer value identifying this event rule.

# paths./api/extras/event-rules/{id}/.patch.parameters[].description
A unique integer value identifying this event rule.

# paths./api/extras/event-rules/{id}/.delete.parameters[].description
A unique integer value identifying this event rule.

# paths./api/extras/export-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/export-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/export-templates/.patch.description
Patch a list of export template objects.

# paths./api/extras/export-templates/.delete.description
Delete a list of export template objects.

# paths./api/extras/export-templates/{id}/.get.parameters[].description
A unique integer value identifying this export template.

# paths./api/extras/export-templates/{id}/.put.parameters[].description
A unique integer value identifying this export template.

# paths./api/extras/export-templates/{id}/.patch.parameters[].description
A unique integer value identifying this export template.

# paths./api/extras/export-templates/{id}/.delete.parameters[].description
A unique integer value identifying this export template.

# paths./api/extras/export-templates/{id}/sync/.post.description
Provide a /sync API endpoint to synchronize an object's data from its associated DataFile (if any).

# paths./api/extras/export-templates/{id}/sync/.post.parameters[].description
A unique integer value identifying this export template.

# paths./api/extras/image-attachments/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/image-attachments/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/image-attachments/.post.description
Post a list of image attachment objects.

# paths./api/extras/image-attachments/.patch.description
Patch a list of image attachment objects.

# paths./api/extras/image-attachments/.delete.description
Delete a list of image attachment objects.

# paths./api/extras/image-attachments/{id}/.get.parameters[].description
A unique integer value identifying this image attachment.

# paths./api/extras/image-attachments/{id}/.put.parameters[].description
A unique integer value identifying this image attachment.

# paths./api/extras/image-attachments/{id}/.patch.parameters[].description
A unique integer value identifying this image attachment.

# paths./api/extras/image-attachments/{id}/.delete.parameters[].description
A unique integer value identifying this image attachment.

# paths./api/extras/journal-entries/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/journal-entries/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/journal-entries/{id}/.get.parameters[].description
A unique integer value identifying this journal entry.

# paths./api/extras/journal-entries/{id}/.put.parameters[].description
A unique integer value identifying this journal entry.

# paths./api/extras/journal-entries/{id}/.patch.parameters[].description
A unique integer value identifying this journal entry.

# paths./api/extras/journal-entries/{id}/.delete.parameters[].description
A unique integer value identifying this journal entry.

# paths./api/extras/notification-groups/.get.description
Get a list of notification group objects.

# paths./api/extras/notification-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/notification-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/notification-groups/.post.description
Post a list of notification group objects.

# paths./api/extras/notification-groups/.put.description
Put a list of notification group objects.

# paths./api/extras/notification-groups/.patch.description
Patch a list of notification group objects.

# paths./api/extras/notification-groups/.delete.description
Delete a list of notification group objects.

# paths./api/extras/notification-groups/{id}/.get.parameters[].description
A unique integer value identifying this notification group.

# paths./api/extras/notification-groups/{id}/.put.parameters[].description
A unique integer value identifying this notification group.

# paths./api/extras/notification-groups/{id}/.patch.parameters[].description
A unique integer value identifying this notification group.

# paths./api/extras/notification-groups/{id}/.delete.parameters[].description
A unique integer value identifying this notification group.

# paths./api/extras/notifications/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/notifications/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/notifications/{id}/.get.parameters[].description
A unique integer value identifying this notification.

# paths./api/extras/notifications/{id}/.put.parameters[].description
A unique integer value identifying this notification.

# paths./api/extras/notifications/{id}/.patch.parameters[].description
A unique integer value identifying this notification.

# paths./api/extras/notifications/{id}/.delete.parameters[].description
A unique integer value identifying this notification.

# paths./api/extras/saved-filters/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/saved-filters/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/saved-filters/{id}/.get.parameters[].description
A unique integer value identifying this saved filter.

# paths./api/extras/saved-filters/{id}/.put.parameters[].description
A unique integer value identifying this saved filter.

# paths./api/extras/saved-filters/{id}/.patch.parameters[].description
A unique integer value identifying this saved filter.

# paths./api/extras/saved-filters/{id}/.delete.parameters[].description
A unique integer value identifying this saved filter.

# paths./api/extras/scripts/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/scripts/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/subscriptions/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/subscriptions/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/subscriptions/{id}/.get.parameters[].description
A unique integer value identifying this subscription.

# paths./api/extras/subscriptions/{id}/.put.parameters[].description
A unique integer value identifying this subscription.

# paths./api/extras/subscriptions/{id}/.patch.parameters[].description
A unique integer value identifying this subscription.

# paths./api/extras/subscriptions/{id}/.delete.parameters[].description
A unique integer value identifying this subscription.

# paths./api/extras/table-configs/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/table-configs/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/table-configs/{id}/.get.parameters[].description
A unique integer value identifying this table config.

# paths./api/extras/table-configs/{id}/.put.parameters[].description
A unique integer value identifying this table config.

# paths./api/extras/table-configs/{id}/.patch.parameters[].description
A unique integer value identifying this table config.

# paths./api/extras/table-configs/{id}/.delete.parameters[].description
A unique integer value identifying this table config.

# paths./api/extras/tagged-objects/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/tagged-objects/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/tagged-objects/{id}/.get.parameters[].description
A unique integer value identifying this tagged item.

# paths./api/extras/tags/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/tags/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/tags/{id}/.get.parameters[].description
A unique integer value identifying this tag.

# paths./api/extras/tags/{id}/.put.parameters[].description
A unique integer value identifying this tag.

# paths./api/extras/tags/{id}/.patch.parameters[].description
A unique integer value identifying this tag.

# paths./api/extras/tags/{id}/.delete.parameters[].description
A unique integer value identifying this tag.

# paths./api/extras/webhooks/.get.parameters[].description
The initial index from which to return the results.

# paths./api/extras/webhooks/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/extras/webhooks/{id}/.get.parameters[].description
A unique integer value identifying this webhook.

# paths./api/extras/webhooks/{id}/.put.parameters[].description
A unique integer value identifying this webhook.

# paths./api/extras/webhooks/{id}/.patch.parameters[].description
A unique integer value identifying this webhook.

# paths./api/extras/webhooks/{id}/.delete.parameters[].description
A unique integer value identifying this webhook.

# paths./api/ipam/aggregates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/aggregates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/aggregates/{id}/.get.parameters[].description
A unique integer value identifying this aggregate.

# paths./api/ipam/aggregates/{id}/.put.parameters[].description
A unique integer value identifying this aggregate.

# paths./api/ipam/aggregates/{id}/.patch.parameters[].description
A unique integer value identifying this aggregate.

# paths./api/ipam/aggregates/{id}/.delete.parameters[].description
A unique integer value identifying this aggregate.

# paths./api/ipam/asn-ranges/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/asn-ranges/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/asn-ranges/{id}/.get.parameters[].description
A unique integer value identifying this ASN range.

# paths./api/ipam/asn-ranges/{id}/.put.parameters[].description
A unique integer value identifying this ASN range.

# paths./api/ipam/asn-ranges/{id}/.patch.parameters[].description
A unique integer value identifying this ASN range.

# paths./api/ipam/asn-ranges/{id}/.delete.parameters[].description
A unique integer value identifying this ASN range.

# paths./api/ipam/asns/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/asns/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/asns/{id}/.get.parameters[].description
A unique integer value identifying this ASN.

# paths./api/ipam/asns/{id}/.put.parameters[].description
A unique integer value identifying this ASN.

# paths./api/ipam/asns/{id}/.patch.parameters[].description
A unique integer value identifying this ASN.

# paths./api/ipam/asns/{id}/.delete.parameters[].description
A unique integer value identifying this ASN.

# paths./api/ipam/fhrp-group-assignments/.get.description
Get a list of FHRP group assignment objects.

# paths./api/ipam/fhrp-group-assignments/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/fhrp-group-assignments/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/fhrp-group-assignments/.post.description
Post a list of FHRP group assignment objects.

# paths./api/ipam/fhrp-group-assignments/.put.description
Put a list of FHRP group assignment objects.

# paths./api/ipam/fhrp-group-assignments/.patch.description
Patch a list of FHRP group assignment objects.

# paths./api/ipam/fhrp-group-assignments/.delete.description
Delete a list of FHRP group assignment objects.

# paths./api/ipam/fhrp-group-assignments/{id}/.get.parameters[].description
A unique integer value identifying this FHRP group assignment.

# paths./api/ipam/fhrp-group-assignments/{id}/.put.parameters[].description
A unique integer value identifying this FHRP group assignment.

# paths./api/ipam/fhrp-group-assignments/{id}/.patch.parameters[].description
A unique integer value identifying this FHRP group assignment.

# paths./api/ipam/fhrp-group-assignments/{id}/.delete.parameters[].description
A unique integer value identifying this FHRP group assignment.

# paths./api/ipam/fhrp-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/fhrp-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/fhrp-groups/{id}/.get.parameters[].description
A unique integer value identifying this FHRP group.

# paths./api/ipam/fhrp-groups/{id}/.put.parameters[].description
A unique integer value identifying this FHRP group.

# paths./api/ipam/fhrp-groups/{id}/.patch.parameters[].description
A unique integer value identifying this FHRP group.

# paths./api/ipam/fhrp-groups/{id}/.delete.parameters[].description
A unique integer value identifying this FHRP group.

# paths./api/ipam/ip-addresses/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/ip-addresses/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/ip-addresses/{id}/.get.parameters[].description
A unique integer value identifying this IP address.

# paths./api/ipam/ip-addresses/{id}/.put.parameters[].description
A unique integer value identifying this IP address.

# paths./api/ipam/ip-addresses/{id}/.patch.parameters[].description
A unique integer value identifying this IP address.

# paths./api/ipam/ip-addresses/{id}/.delete.parameters[].description
A unique integer value identifying this IP address.

# paths./api/ipam/ip-ranges/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/ip-ranges/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/ip-ranges/{id}/.get.parameters[].description
A unique integer value identifying this IP range.

# paths./api/ipam/ip-ranges/{id}/.put.parameters[].description
A unique integer value identifying this IP range.

# paths./api/ipam/ip-ranges/{id}/.patch.parameters[].description
A unique integer value identifying this IP range.

# paths./api/ipam/ip-ranges/{id}/.delete.parameters[].description
A unique integer value identifying this IP range.

# paths./api/ipam/prefixes/.get.parameters[].description
Prefixes which contain this prefix or IP

# paths./api/ipam/prefixes/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/prefixes/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/prefixes/{id}/.get.parameters[].description
A unique integer value identifying this prefix.

# paths./api/ipam/prefixes/{id}/.put.parameters[].description
A unique integer value identifying this prefix.

# paths./api/ipam/prefixes/{id}/.patch.parameters[].description
A unique integer value identifying this prefix.

# paths./api/ipam/prefixes/{id}/.delete.parameters[].description
A unique integer value identifying this prefix.

# paths./api/ipam/rirs/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/rirs/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/rirs/{id}/.get.parameters[].description
A unique integer value identifying this RIR.

# paths./api/ipam/rirs/{id}/.put.parameters[].description
A unique integer value identifying this RIR.

# paths./api/ipam/rirs/{id}/.patch.parameters[].description
A unique integer value identifying this RIR.

# paths./api/ipam/rirs/{id}/.delete.parameters[].description
A unique integer value identifying this RIR.

# paths./api/ipam/roles/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/roles/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/roles/{id}/.get.parameters[].description
A unique integer value identifying this role.

# paths./api/ipam/roles/{id}/.put.parameters[].description
A unique integer value identifying this role.

# paths./api/ipam/roles/{id}/.patch.parameters[].description
A unique integer value identifying this role.

# paths./api/ipam/roles/{id}/.delete.parameters[].description
A unique integer value identifying this role.

# paths./api/ipam/route-targets/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/route-targets/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/route-targets/{id}/.get.parameters[].description
A unique integer value identifying this route target.

# paths./api/ipam/route-targets/{id}/.put.parameters[].description
A unique integer value identifying this route target.

# paths./api/ipam/route-targets/{id}/.patch.parameters[].description
A unique integer value identifying this route target.

# paths./api/ipam/route-targets/{id}/.delete.parameters[].description
A unique integer value identifying this route target.

# paths./api/ipam/service-templates/.get.description
Get a list of application service template objects.

# paths./api/ipam/service-templates/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/service-templates/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/service-templates/.get.parameters[].description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# paths./api/ipam/service-templates/.get.parameters[].description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# paths./api/ipam/service-templates/.post.description
Post a list of application service template objects.

# paths./api/ipam/service-templates/.put.description
Put a list of application service template objects.

# paths./api/ipam/service-templates/.patch.description
Patch a list of application service template objects.

# paths./api/ipam/service-templates/.delete.description
Delete a list of application service template objects.

# paths./api/ipam/service-templates/{id}/.get.description
Get a application service template object.

# paths./api/ipam/service-templates/{id}/.get.parameters[].description
A unique integer value identifying this application service template.

# paths./api/ipam/service-templates/{id}/.put.description
Put a application service template object.

# paths./api/ipam/service-templates/{id}/.put.parameters[].description
A unique integer value identifying this application service template.

# paths./api/ipam/service-templates/{id}/.patch.description
Patch a application service template object.

# paths./api/ipam/service-templates/{id}/.patch.parameters[].description
A unique integer value identifying this application service template.

# paths./api/ipam/service-templates/{id}/.delete.description
Delete a application service template object.

# paths./api/ipam/service-templates/{id}/.delete.parameters[].description
A unique integer value identifying this application service template.

# paths./api/ipam/services/.get.description
Get a list of application service objects.

# paths./api/ipam/services/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/services/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/services/.get.parameters[].description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# paths./api/ipam/services/.get.parameters[].description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# paths./api/ipam/services/.post.description
Post a list of application service objects.

# paths./api/ipam/services/.put.description
Put a list of application service objects.

# paths./api/ipam/services/.patch.description
Patch a list of application service objects.

# paths./api/ipam/services/.delete.description
Delete a list of application service objects.

# paths./api/ipam/services/{id}/.get.parameters[].description
A unique integer value identifying this application service.

# paths./api/ipam/services/{id}/.put.parameters[].description
A unique integer value identifying this application service.

# paths./api/ipam/services/{id}/.patch.parameters[].description
A unique integer value identifying this application service.

# paths./api/ipam/services/{id}/.delete.parameters[].description
A unique integer value identifying this application service.

# paths./api/ipam/vlan-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/vlan-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/vlan-groups/{id}/.get.parameters[].description
A unique integer value identifying this VLAN group.

# paths./api/ipam/vlan-groups/{id}/.put.parameters[].description
A unique integer value identifying this VLAN group.

# paths./api/ipam/vlan-groups/{id}/.patch.parameters[].description
A unique integer value identifying this VLAN group.

# paths./api/ipam/vlan-groups/{id}/.delete.parameters[].description
A unique integer value identifying this VLAN group.

# paths./api/ipam/vlan-translation-policies/.get.description
Get a list of VLAN translation policy objects.

# paths./api/ipam/vlan-translation-policies/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/vlan-translation-policies/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/vlan-translation-policies/.post.description
Post a list of VLAN translation policy objects.

# paths./api/ipam/vlan-translation-policies/.put.description
Put a list of VLAN translation policy objects.

# paths./api/ipam/vlan-translation-policies/.patch.description
Patch a list of VLAN translation policy objects.

# paths./api/ipam/vlan-translation-policies/.delete.description
Delete a list of VLAN translation policy objects.

# paths./api/ipam/vlan-translation-policies/{id}/.get.parameters[].description
A unique integer value identifying this VLAN translation policy.

# paths./api/ipam/vlan-translation-policies/{id}/.put.parameters[].description
A unique integer value identifying this VLAN translation policy.

# paths./api/ipam/vlan-translation-policies/{id}/.patch.parameters[].description
A unique integer value identifying this VLAN translation policy.

# paths./api/ipam/vlan-translation-policies/{id}/.delete.description
Delete a VLAN translation policy object.

# paths./api/ipam/vlan-translation-policies/{id}/.delete.parameters[].description
A unique integer value identifying this VLAN translation policy.

# paths./api/ipam/vlan-translation-rules/.get.description
Get a list of VLAN translation rule objects.

# paths./api/ipam/vlan-translation-rules/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/vlan-translation-rules/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/vlan-translation-rules/.post.description
Post a list of VLAN translation rule objects.

# paths./api/ipam/vlan-translation-rules/.put.description
Put a list of VLAN translation rule objects.

# paths./api/ipam/vlan-translation-rules/.patch.description
Patch a list of VLAN translation rule objects.

# paths./api/ipam/vlan-translation-rules/.delete.description
Delete a list of VLAN translation rule objects.

# paths./api/ipam/vlan-translation-rules/{id}/.get.parameters[].description
A unique integer value identifying this VLAN translation rule.

# paths./api/ipam/vlan-translation-rules/{id}/.put.parameters[].description
A unique integer value identifying this VLAN translation rule.

# paths./api/ipam/vlan-translation-rules/{id}/.patch.parameters[].description
A unique integer value identifying this VLAN translation rule.

# paths./api/ipam/vlan-translation-rules/{id}/.delete.parameters[].description
A unique integer value identifying this VLAN translation rule.

# paths./api/ipam/vlans/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/vlans/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/.get.parameters[].description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

# paths./api/ipam/vlans/{id}/.get.parameters[].description
A unique integer value identifying this VLAN.

# paths./api/ipam/vlans/{id}/.put.parameters[].description
A unique integer value identifying this VLAN.

# paths./api/ipam/vlans/{id}/.patch.parameters[].description
A unique integer value identifying this VLAN.

# paths./api/ipam/vlans/{id}/.delete.parameters[].description
A unique integer value identifying this VLAN.

# paths./api/ipam/vrfs/.get.parameters[].description
The initial index from which to return the results.

# paths./api/ipam/vrfs/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/ipam/vrfs/{id}/.get.parameters[].description
A unique integer value identifying this VRF.

# paths./api/ipam/vrfs/{id}/.put.parameters[].description
A unique integer value identifying this VRF.

# paths./api/ipam/vrfs/{id}/.patch.parameters[].description
A unique integer value identifying this VRF.

# paths./api/ipam/vrfs/{id}/.delete.parameters[].description
A unique integer value identifying this VRF.

# paths./api/schema/.get.description
OpenApi3 schema for this API. Format can be selected via content negotiation.

- YAML: application/vnd.oai.openapi
- JSON: application/vnd.oai.openapi+json

# paths./api/status/.get.description
A lightweight read-only endpoint for conveying NetBox's current operational status.

# paths./api/tenancy/contact-assignments/.get.description
Get a list of contact assignment objects.

# paths./api/tenancy/contact-assignments/.get.parameters[].description
The initial index from which to return the results.

# paths./api/tenancy/contact-assignments/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/tenancy/contact-assignments/.get.parameters[].description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# paths./api/tenancy/contact-assignments/.get.parameters[].description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# paths./api/tenancy/contact-assignments/.post.description
Post a list of contact assignment objects.

# paths./api/tenancy/contact-assignments/.put.description
Put a list of contact assignment objects.

# paths./api/tenancy/contact-assignments/.patch.description
Patch a list of contact assignment objects.

# paths./api/tenancy/contact-assignments/.delete.description
Delete a list of contact assignment objects.

# paths./api/tenancy/contact-assignments/{id}/.get.parameters[].description
A unique integer value identifying this contact assignment.

# paths./api/tenancy/contact-assignments/{id}/.put.parameters[].description
A unique integer value identifying this contact assignment.

# paths./api/tenancy/contact-assignments/{id}/.patch.parameters[].description
A unique integer value identifying this contact assignment.

# paths./api/tenancy/contact-assignments/{id}/.delete.parameters[].description
A unique integer value identifying this contact assignment.

# paths./api/tenancy/contact-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/tenancy/contact-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/tenancy/contact-groups/{id}/.get.parameters[].description
A unique integer value identifying this contact group.

# paths./api/tenancy/contact-groups/{id}/.put.parameters[].description
A unique integer value identifying this contact group.

# paths./api/tenancy/contact-groups/{id}/.patch.parameters[].description
A unique integer value identifying this contact group.

# paths./api/tenancy/contact-groups/{id}/.delete.parameters[].description
A unique integer value identifying this contact group.

# paths./api/tenancy/contact-roles/.get.parameters[].description
The initial index from which to return the results.

# paths./api/tenancy/contact-roles/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/tenancy/contact-roles/{id}/.get.parameters[].description
A unique integer value identifying this contact role.

# paths./api/tenancy/contact-roles/{id}/.put.parameters[].description
A unique integer value identifying this contact role.

# paths./api/tenancy/contact-roles/{id}/.patch.parameters[].description
A unique integer value identifying this contact role.

# paths./api/tenancy/contact-roles/{id}/.delete.parameters[].description
A unique integer value identifying this contact role.

# paths./api/tenancy/contacts/.get.parameters[].description
The initial index from which to return the results.

# paths./api/tenancy/contacts/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/tenancy/contacts/{id}/.get.parameters[].description
A unique integer value identifying this contact.

# paths./api/tenancy/contacts/{id}/.put.parameters[].description
A unique integer value identifying this contact.

# paths./api/tenancy/contacts/{id}/.patch.parameters[].description
A unique integer value identifying this contact.

# paths./api/tenancy/contacts/{id}/.delete.parameters[].description
A unique integer value identifying this contact.

# paths./api/tenancy/tenant-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/tenancy/tenant-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/tenancy/tenant-groups/{id}/.get.parameters[].description
A unique integer value identifying this tenant group.

# paths./api/tenancy/tenant-groups/{id}/.put.parameters[].description
A unique integer value identifying this tenant group.

# paths./api/tenancy/tenant-groups/{id}/.patch.parameters[].description
A unique integer value identifying this tenant group.

# paths./api/tenancy/tenant-groups/{id}/.delete.parameters[].description
A unique integer value identifying this tenant group.

# paths./api/tenancy/tenants/.get.parameters[].description
The initial index from which to return the results.

# paths./api/tenancy/tenants/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/tenancy/tenants/{id}/.get.parameters[].description
A unique integer value identifying this tenant.

# paths./api/tenancy/tenants/{id}/.put.parameters[].description
A unique integer value identifying this tenant.

# paths./api/tenancy/tenants/{id}/.patch.parameters[].description
A unique integer value identifying this tenant.

# paths./api/tenancy/tenants/{id}/.delete.parameters[].description
A unique integer value identifying this tenant.

# paths./api/users/config/.get.description
An API endpoint via which a user can update his or her own UserConfig data (but no one else's).

# paths./api/users/groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/users/groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/users/groups/{id}/.get.parameters[].description
A unique integer value identifying this group.

# paths./api/users/groups/{id}/.put.parameters[].description
A unique integer value identifying this group.

# paths./api/users/groups/{id}/.patch.parameters[].description
A unique integer value identifying this group.

# paths./api/users/groups/{id}/.delete.parameters[].description
A unique integer value identifying this group.

# paths./api/users/owner-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/users/owner-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/users/owner-groups/{id}/.get.parameters[].description
A unique integer value identifying this owner group.

# paths./api/users/owner-groups/{id}/.put.parameters[].description
A unique integer value identifying this owner group.

# paths./api/users/owner-groups/{id}/.patch.parameters[].description
A unique integer value identifying this owner group.

# paths./api/users/owner-groups/{id}/.delete.parameters[].description
A unique integer value identifying this owner group.

# paths./api/users/owners/.get.parameters[].description
The initial index from which to return the results.

# paths./api/users/owners/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/users/owners/{id}/.get.parameters[].description
A unique integer value identifying this owner.

# paths./api/users/owners/{id}/.put.parameters[].description
A unique integer value identifying this owner.

# paths./api/users/owners/{id}/.patch.parameters[].description
A unique integer value identifying this owner.

# paths./api/users/owners/{id}/.delete.parameters[].description
A unique integer value identifying this owner.

# paths./api/users/permissions/.get.parameters[].description
The initial index from which to return the results.

# paths./api/users/permissions/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/users/permissions/{id}/.get.parameters[].description
A unique integer value identifying this permission.

# paths./api/users/permissions/{id}/.put.parameters[].description
A unique integer value identifying this permission.

# paths./api/users/permissions/{id}/.patch.parameters[].description
A unique integer value identifying this permission.

# paths./api/users/permissions/{id}/.delete.parameters[].description
A unique integer value identifying this permission.

# paths./api/users/tokens/.get.parameters[].description
The initial index from which to return the results.

# paths./api/users/tokens/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/users/tokens/{id}/.get.parameters[].description
A unique integer value identifying this token.

# paths./api/users/tokens/{id}/.put.parameters[].description
A unique integer value identifying this token.

# paths./api/users/tokens/{id}/.patch.parameters[].description
A unique integer value identifying this token.

# paths./api/users/tokens/{id}/.delete.parameters[].description
A unique integer value identifying this token.

# paths./api/users/tokens/provision/.post.description
Non-authenticated REST API endpoint via which a user may create a Token.

# paths./api/users/users/.get.parameters[].description
The initial index from which to return the results.

# paths./api/users/users/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/users/users/{id}/.get.parameters[].description
A unique integer value identifying this user.

# paths./api/users/users/{id}/.put.parameters[].description
A unique integer value identifying this user.

# paths./api/users/users/{id}/.patch.parameters[].description
A unique integer value identifying this user.

# paths./api/users/users/{id}/.delete.parameters[].description
A unique integer value identifying this user.

# paths./api/virtualization/cluster-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/virtualization/cluster-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/virtualization/cluster-groups/{id}/.get.parameters[].description
A unique integer value identifying this cluster group.

# paths./api/virtualization/cluster-groups/{id}/.put.parameters[].description
A unique integer value identifying this cluster group.

# paths./api/virtualization/cluster-groups/{id}/.patch.parameters[].description
A unique integer value identifying this cluster group.

# paths./api/virtualization/cluster-groups/{id}/.delete.parameters[].description
A unique integer value identifying this cluster group.

# paths./api/virtualization/cluster-types/.get.parameters[].description
The initial index from which to return the results.

# paths./api/virtualization/cluster-types/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/virtualization/cluster-types/{id}/.get.parameters[].description
A unique integer value identifying this cluster type.

# paths./api/virtualization/cluster-types/{id}/.put.parameters[].description
A unique integer value identifying this cluster type.

# paths./api/virtualization/cluster-types/{id}/.patch.parameters[].description
A unique integer value identifying this cluster type.

# paths./api/virtualization/cluster-types/{id}/.delete.parameters[].description
A unique integer value identifying this cluster type.

# paths./api/virtualization/clusters/.get.parameters[].description
The initial index from which to return the results.

# paths./api/virtualization/clusters/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/virtualization/clusters/{id}/.get.parameters[].description
A unique integer value identifying this cluster.

# paths./api/virtualization/clusters/{id}/.put.parameters[].description
A unique integer value identifying this cluster.

# paths./api/virtualization/clusters/{id}/.patch.parameters[].description
A unique integer value identifying this cluster.

# paths./api/virtualization/clusters/{id}/.delete.parameters[].description
A unique integer value identifying this cluster.

# paths./api/virtualization/interfaces/.get.parameters[].description
The initial index from which to return the results.

# paths./api/virtualization/interfaces/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/virtualization/interfaces/{id}/.get.parameters[].description
A unique integer value identifying this interface.

# paths./api/virtualization/interfaces/{id}/.put.parameters[].description
A unique integer value identifying this interface.

# paths./api/virtualization/interfaces/{id}/.patch.parameters[].description
A unique integer value identifying this interface.

# paths./api/virtualization/interfaces/{id}/.delete.parameters[].description
A unique integer value identifying this interface.

# paths./api/virtualization/virtual-disks/.get.parameters[].description
The initial index from which to return the results.

# paths./api/virtualization/virtual-disks/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/virtualization/virtual-disks/{id}/.get.parameters[].description
A unique integer value identifying this virtual disk.

# paths./api/virtualization/virtual-disks/{id}/.put.parameters[].description
A unique integer value identifying this virtual disk.

# paths./api/virtualization/virtual-disks/{id}/.patch.parameters[].description
A unique integer value identifying this virtual disk.

# paths./api/virtualization/virtual-disks/{id}/.delete.parameters[].description
A unique integer value identifying this virtual disk.

# paths./api/virtualization/virtual-machines/.get.parameters[].description
The initial index from which to return the results.

# paths./api/virtualization/virtual-machines/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/virtualization/virtual-machines/.patch.description
Patch a list of virtual machine objects.

# paths./api/virtualization/virtual-machines/.delete.description
Delete a list of virtual machine objects.

# paths./api/virtualization/virtual-machines/{id}/.get.parameters[].description
A unique integer value identifying this virtual machine.

# paths./api/virtualization/virtual-machines/{id}/.put.parameters[].description
A unique integer value identifying this virtual machine.

# paths./api/virtualization/virtual-machines/{id}/.patch.parameters[].description
A unique integer value identifying this virtual machine.

# paths./api/virtualization/virtual-machines/{id}/.delete.parameters[].description
A unique integer value identifying this virtual machine.

# paths./api/virtualization/virtual-machines/{id}/render-config/.post.description
Resolve and render the preferred ConfigTemplate for this Device.

# paths./api/virtualization/virtual-machines/{id}/render-config/.post.parameters[].description
A unique integer value identifying this virtual machine.

# paths./api/vpn/ike-policies/.get.parameters[].description
The initial index from which to return the results.

# paths./api/vpn/ike-policies/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/vpn/ike-policies/{id}/.get.parameters[].description
A unique integer value identifying this IKE policy.

# paths./api/vpn/ike-policies/{id}/.put.parameters[].description
A unique integer value identifying this IKE policy.

# paths./api/vpn/ike-policies/{id}/.patch.parameters[].description
A unique integer value identifying this IKE policy.

# paths./api/vpn/ike-policies/{id}/.delete.parameters[].description
A unique integer value identifying this IKE policy.

# paths./api/vpn/ike-proposals/.get.parameters[].description
The initial index from which to return the results.

# paths./api/vpn/ike-proposals/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/vpn/ike-proposals/{id}/.get.parameters[].description
A unique integer value identifying this IKE proposal.

# paths./api/vpn/ike-proposals/{id}/.put.parameters[].description
A unique integer value identifying this IKE proposal.

# paths./api/vpn/ike-proposals/{id}/.patch.parameters[].description
A unique integer value identifying this IKE proposal.

# paths./api/vpn/ike-proposals/{id}/.delete.parameters[].description
A unique integer value identifying this IKE proposal.

# paths./api/vpn/ipsec-policies/.get.parameters[].description
The initial index from which to return the results.

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/.get.parameters[].description
Diffie-Hellman group for Perfect Forward Secrecy

# paths./api/vpn/ipsec-policies/{id}/.get.parameters[].description
A unique integer value identifying this IPSec policy.

# paths./api/vpn/ipsec-policies/{id}/.put.parameters[].description
A unique integer value identifying this IPSec policy.

# paths./api/vpn/ipsec-policies/{id}/.patch.parameters[].description
A unique integer value identifying this IPSec policy.

# paths./api/vpn/ipsec-policies/{id}/.delete.parameters[].description
A unique integer value identifying this IPSec policy.

# paths./api/vpn/ipsec-profiles/.get.parameters[].description
The initial index from which to return the results.

# paths./api/vpn/ipsec-profiles/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/vpn/ipsec-profiles/{id}/.get.parameters[].description
A unique integer value identifying this IPSec profile.

# paths./api/vpn/ipsec-profiles/{id}/.put.parameters[].description
A unique integer value identifying this IPSec profile.

# paths./api/vpn/ipsec-profiles/{id}/.patch.parameters[].description
A unique integer value identifying this IPSec profile.

# paths./api/vpn/ipsec-profiles/{id}/.delete.parameters[].description
A unique integer value identifying this IPSec profile.

# paths./api/vpn/ipsec-proposals/.get.parameters[].description
The initial index from which to return the results.

# paths./api/vpn/ipsec-proposals/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/vpn/ipsec-proposals/.delete.description
Delete a list of IPSec proposal objects.

# paths./api/vpn/ipsec-proposals/{id}/.get.parameters[].description
A unique integer value identifying this IPSec proposal.

# paths./api/vpn/ipsec-proposals/{id}/.put.parameters[].description
A unique integer value identifying this IPSec proposal.

# paths./api/vpn/ipsec-proposals/{id}/.patch.parameters[].description
A unique integer value identifying this IPSec proposal.

# paths./api/vpn/ipsec-proposals/{id}/.delete.parameters[].description
A unique integer value identifying this IPSec proposal.

# paths./api/vpn/l2vpn-terminations/.get.description
Get a list of L2VPN termination objects.

# paths./api/vpn/l2vpn-terminations/.get.parameters[].description
The initial index from which to return the results.

# paths./api/vpn/l2vpn-terminations/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/vpn/l2vpn-terminations/.post.description
Post a list of L2VPN termination objects.

# paths./api/vpn/l2vpn-terminations/.put.description
Put a list of L2VPN termination objects.

# paths./api/vpn/l2vpn-terminations/.patch.description
Patch a list of L2VPN termination objects.

# paths./api/vpn/l2vpn-terminations/.delete.description
Delete a list of L2VPN termination objects.

# paths./api/vpn/l2vpn-terminations/{id}/.get.parameters[].description
A unique integer value identifying this L2VPN termination.

# paths./api/vpn/l2vpn-terminations/{id}/.put.parameters[].description
A unique integer value identifying this L2VPN termination.

# paths./api/vpn/l2vpn-terminations/{id}/.patch.parameters[].description
A unique integer value identifying this L2VPN termination.

# paths./api/vpn/l2vpn-terminations/{id}/.delete.parameters[].description
A unique integer value identifying this L2VPN termination.

# paths./api/vpn/l2vpns/.get.parameters[].description
The initial index from which to return the results.

# paths./api/vpn/l2vpns/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/vpn/l2vpns/{id}/.get.parameters[].description
A unique integer value identifying this L2VPN.

# paths./api/vpn/l2vpns/{id}/.put.parameters[].description
A unique integer value identifying this L2VPN.

# paths./api/vpn/l2vpns/{id}/.patch.parameters[].description
A unique integer value identifying this L2VPN.

# paths./api/vpn/l2vpns/{id}/.delete.parameters[].description
A unique integer value identifying this L2VPN.

# paths./api/vpn/tunnel-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/vpn/tunnel-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/vpn/tunnel-groups/{id}/.get.parameters[].description
A unique integer value identifying this tunnel group.

# paths./api/vpn/tunnel-groups/{id}/.put.parameters[].description
A unique integer value identifying this tunnel group.

# paths./api/vpn/tunnel-groups/{id}/.patch.parameters[].description
A unique integer value identifying this tunnel group.

# paths./api/vpn/tunnel-groups/{id}/.delete.parameters[].description
A unique integer value identifying this tunnel group.

# paths./api/vpn/tunnel-terminations/.get.description
Get a list of tunnel termination objects.

# paths./api/vpn/tunnel-terminations/.get.parameters[].description
The initial index from which to return the results.

# paths./api/vpn/tunnel-terminations/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/vpn/tunnel-terminations/.post.description
Post a list of tunnel termination objects.

# paths./api/vpn/tunnel-terminations/.put.description
Put a list of tunnel termination objects.

# paths./api/vpn/tunnel-terminations/.patch.description
Patch a list of tunnel termination objects.

# paths./api/vpn/tunnel-terminations/.delete.description
Delete a list of tunnel termination objects.

# paths./api/vpn/tunnel-terminations/{id}/.get.parameters[].description
A unique integer value identifying this tunnel termination.

# paths./api/vpn/tunnel-terminations/{id}/.put.parameters[].description
A unique integer value identifying this tunnel termination.

# paths./api/vpn/tunnel-terminations/{id}/.patch.parameters[].description
A unique integer value identifying this tunnel termination.

# paths./api/vpn/tunnel-terminations/{id}/.delete.parameters[].description
A unique integer value identifying this tunnel termination.

# paths./api/vpn/tunnels/.get.parameters[].description
The initial index from which to return the results.

# paths./api/vpn/tunnels/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/vpn/tunnels/{id}/.get.parameters[].description
A unique integer value identifying this tunnel.

# paths./api/vpn/tunnels/{id}/.put.parameters[].description
A unique integer value identifying this tunnel.

# paths./api/vpn/tunnels/{id}/.patch.parameters[].description
A unique integer value identifying this tunnel.

# paths./api/vpn/tunnels/{id}/.delete.parameters[].description
A unique integer value identifying this tunnel.

# paths./api/wireless/wireless-lan-groups/.get.description
Get a list of wireless LAN group objects.

# paths./api/wireless/wireless-lan-groups/.get.parameters[].description
The initial index from which to return the results.

# paths./api/wireless/wireless-lan-groups/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/wireless/wireless-lan-groups/.post.description
Post a list of wireless LAN group objects.

# paths./api/wireless/wireless-lan-groups/.put.description
Put a list of wireless LAN group objects.

# paths./api/wireless/wireless-lan-groups/.patch.description
Patch a list of wireless LAN group objects.

# paths./api/wireless/wireless-lan-groups/.delete.description
Delete a list of wireless LAN group objects.

# paths./api/wireless/wireless-lan-groups/{id}/.get.parameters[].description
A unique integer value identifying this wireless LAN group.

# paths./api/wireless/wireless-lan-groups/{id}/.put.parameters[].description
A unique integer value identifying this wireless LAN group.

# paths./api/wireless/wireless-lan-groups/{id}/.patch.parameters[].description
A unique integer value identifying this wireless LAN group.

# paths./api/wireless/wireless-lan-groups/{id}/.delete.parameters[].description
A unique integer value identifying this wireless LAN group.

# paths./api/wireless/wireless-lans/.get.parameters[].description
The initial index from which to return the results.

# paths./api/wireless/wireless-lans/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/wireless/wireless-lans/{id}/.get.parameters[].description
A unique integer value identifying this wireless LAN.

# paths./api/wireless/wireless-lans/{id}/.put.parameters[].description
A unique integer value identifying this wireless LAN.

# paths./api/wireless/wireless-lans/{id}/.patch.parameters[].description
A unique integer value identifying this wireless LAN.

# paths./api/wireless/wireless-lans/{id}/.delete.parameters[].description
A unique integer value identifying this wireless LAN.

# paths./api/wireless/wireless-links/.get.parameters[].description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# paths./api/wireless/wireless-links/.get.parameters[].description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# paths./api/wireless/wireless-links/.get.parameters[].description
The initial index from which to return the results.

# paths./api/wireless/wireless-links/.get.parameters[].description
Which field to use when ordering the results.

# paths./api/wireless/wireless-links/{id}/.get.parameters[].description
A unique integer value identifying this wireless link.

# paths./api/wireless/wireless-links/{id}/.put.parameters[].description
A unique integer value identifying this wireless link.

# paths./api/wireless/wireless-links/{id}/.patch.parameters[].description
A unique integer value identifying this wireless link.

# paths./api/wireless/wireless-links/{id}/.delete.parameters[].description
A unique integer value identifying this wireless link.

# components.schemas.ASN.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ASNRange.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.ASNRangeRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.ASNRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ASNSite.description
This serializer is meant for inclusion in ASNSerializer and is only used
to avoid a circular import of SiteSerializer.

# components.schemas.Aggregate.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.AggregateRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.AvailableASN.description
Representation of an ASN which does not exist in the database.

# components.schemas.AvailableIP.description
Representation of an IP address which does not exist in the database.

# components.schemas.AvailableIPRequestRequest.description
Request payload for creating IP addresses from the available-ips endpoint.

# components.schemas.AvailablePrefix.description
Representation of a prefix which does not exist in the database.

# components.schemas.AvailableVLAN.description
Representation of a VLAN which does not exist in the database.

# components.schemas.Bookmark.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.BookmarkRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.BriefCable.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefCableRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefCircuit.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefCircuitGroup.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefCircuitGroupAssignmentSerializer_.description
Base serializer for group assignments under CircuitSerializer.

# components.schemas.BriefCircuitGroupAssignmentSerializer_.properties.priority.properties.value.description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# components.schemas.BriefCircuitGroupAssignmentSerializer_Request.description
Base serializer for group assignments under CircuitSerializer.

# components.schemas.BriefCircuitGroupAssignmentSerializer_Request.properties.priority.description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# components.schemas.BriefCircuitGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefCircuitRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefCircuitType.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefCircuitTypeRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefCluster.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefClusterGroup.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefClusterGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefClusterRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefClusterType.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefClusterTypeRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefConfigContextProfile.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefConfigContextProfileRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefConfigTemplate.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.BriefConfigTemplateRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.BriefContact.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefContactRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefContactRole.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefContactRoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefCustomFieldChoiceSet.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.BriefCustomFieldChoiceSetRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.BriefDataFile.description
Adds support for custom fields and tags.

# components.schemas.BriefDataFile.properties.path.description
File path relative to the data source's root

# components.schemas.BriefDataSource.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefDataSourceRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefDevice.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefDeviceRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefDeviceRole.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefDeviceRoleRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefDeviceType.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefDeviceTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefFHRPGroup.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefFHRPGroup.properties.protocol.description
* `vrrp2` - VRRPv2
* `vrrp3` - VRRPv3
* `carp` - CARP
* `clusterxl` - ClusterXL
* `hsrp` - HSRP
* `glbp` - GLBP
* `other` - Other

# components.schemas.BriefFHRPGroupRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefFHRPGroupRequest.properties.protocol.description
* `vrrp2` - VRRPv2
* `vrrp3` - VRRPv3
* `carp` - CARP
* `clusterxl` - ClusterXL
* `hsrp` - HSRP
* `glbp` - GLBP
* `other` - Other

# components.schemas.BriefIKEPolicy.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefIKEPolicyRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefIPAddress.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefIPAddressRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefIPSecPolicy.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefIPSecPolicyRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefIPSecProfile.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefIPSecProfileRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefInterface.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.BriefInterfaceRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.BriefInventoryItemRole.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefInventoryItemRoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefJob.properties.status.properties.value.description
* `pending` - Pending
* `scheduled` - Scheduled
* `running` - Running
* `completed` - Completed
* `errored` - Errored
* `failed` - Failed

# components.schemas.BriefL2VPN.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefL2VPN.properties.type.properties.value.description
* `vpws` - VPWS
* `vpls` - VPLS
* `vxlan` - VXLAN
* `vxlan-evpn` - VXLAN-EVPN
* `mpls-evpn` - MPLS EVPN
* `pbb-evpn` - PBB EVPN
* `evpn-vpws` - EVPN VPWS
* `epl` - EPL
* `evpl` - EVPL
* `ep-lan` - Ethernet Private LAN
* `evp-lan` - Ethernet Virtual Private LAN
* `ep-tree` - Ethernet Private Tree
* `evp-tree` - Ethernet Virtual Private Tree
* `spb` - SPB

# components.schemas.BriefL2VPNRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefL2VPNRequest.properties.type.description
* `vpws` - VPWS
* `vpls` - VPLS
* `vxlan` - VXLAN
* `vxlan-evpn` - VXLAN-EVPN
* `mpls-evpn` - MPLS EVPN
* `pbb-evpn` - PBB EVPN
* `evpn-vpws` - EVPN VPWS
* `epl` - EPL
* `evpl` - EVPL
* `ep-lan` - Ethernet Private LAN
* `evp-lan` - Ethernet Virtual Private LAN
* `ep-tree` - Ethernet Private Tree
* `evp-tree` - Ethernet Virtual Private Tree
* `spb` - SPB

# components.schemas.BriefL2VPNTermination.description
Adds support for custom fields and tags.

# components.schemas.BriefL2VPNTerminationRequest.description
Adds support for custom fields and tags.

# components.schemas.BriefLocation.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefLocationRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefMACAddress.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefMACAddressRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefManufacturer.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefManufacturerRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefModule.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefModuleRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefModuleType.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefModuleTypeProfile.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefModuleTypeProfileRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefModuleTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefOwner.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.BriefOwnerGroup.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.BriefOwnerGroupRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.BriefOwnerRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.BriefPlatform.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefPlatformRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefPowerPanel.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefPowerPanelRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefPowerPort.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.BriefPowerPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.BriefPowerPortTemplate.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.BriefPowerPortTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.BriefPowerPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.BriefPowerPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.BriefProvider.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefProviderAccount.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefProviderAccountRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefProviderNetwork.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefProviderNetworkRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefProviderRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefRIR.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefRIRRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefRack.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefRackRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefRackRole.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefRackRoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefRackType.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefRackTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefRegion.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefRegionRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefRole.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefRoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefSite.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefSiteGroup.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefSiteGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefSiteRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefTag.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.BriefTenant.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefTenantGroup.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefTenantGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefTenantRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefTunnel.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefTunnelGroup.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefTunnelGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefTunnelRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefUser.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.BriefUser.properties.username.description
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# components.schemas.BriefUserRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.BriefUserRequest.properties.username.description
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# components.schemas.BriefVLAN.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefVLANGroup.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefVLANGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefVLANRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefVLANTranslationPolicy.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefVLANTranslationPolicyRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefVRF.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefVRF.properties.rd.description
Unique route distinguisher (as defined in RFC 4364)

# components.schemas.BriefVRFRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefVRFRequest.properties.rd.description
Unique route distinguisher (as defined in RFC 4364)

# components.schemas.BriefVirtualChassis.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefVirtualChassisRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefVirtualCircuit.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefVirtualCircuitRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefVirtualCircuitType.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefVirtualCircuitTypeRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.BriefVirtualMachine.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefVirtualMachineRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.BriefWirelessLANGroup.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.BriefWirelessLANGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.Cable.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Cable.properties.type.description
* `cat3` - CAT3
* `cat5` - CAT5
* `cat5e` - CAT5e
* `cat6` - CAT6
* `cat6a` - CAT6a
* `cat7` - CAT7
* `cat7a` - CAT7a
* `cat8` - CAT8
* `mrj21-trunk` - MRJ21 Trunk
* `dac-active` - Direct Attach Copper (Active)
* `dac-passive` - Direct Attach Copper (Passive)
* `coaxial` - Coaxial
* `rg-6` - RG-6
* `rg-8` - RG-8
* `rg-11` - RG-11
* `rg-59` - RG-59
* `rg-62` - RG-62
* `rg-213` - RG-213
* `lmr-100` - LMR-100
* `lmr-200` - LMR-200
* `lmr-400` - LMR-400
* `mmf` - Multimode Fiber
* `mmf-om1` - Multimode Fiber (OM1)
* `mmf-om2` - Multimode Fiber (OM2)
* `mmf-om3` - Multimode Fiber (OM3)
* `mmf-om4` - Multimode Fiber (OM4)
* `mmf-om5` - Multimode Fiber (OM5)
* `smf` - Single-mode Fiber
* `smf-os1` - Single-mode Fiber (OS1)
* `smf-os2` - Single-mode Fiber (OS2)
* `aoc` - Active Optical Cabling (AOC)
* `power` - Power
* `usb` - USB

# components.schemas.Cable.properties.status.properties.value.description
* `connected` - Connected
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.Cable.properties.profile.properties.value.description
* `single-1c1p` - 1C1P
* `single-1c2p` - 1C2P
* `single-1c4p` - 1C4P
* `single-1c6p` - 1C6P
* `single-1c8p` - 1C8P
* `single-1c12p` - 1C12P
* `single-1c16p` - 1C16P
* `trunk-2c1p` - 2C1P trunk
* `trunk-2c2p` - 2C2P trunk
* `trunk-2c4p` - 2C4P trunk
* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)
* `trunk-2c6p` - 2C6P trunk
* `trunk-2c8p` - 2C8P trunk
* `trunk-2c12p` - 2C12P trunk
* `trunk-4c1p` - 4C1P trunk
* `trunk-4c2p` - 4C2P trunk
* `trunk-4c4p` - 4C4P trunk
* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)
* `trunk-4c6p` - 4C6P trunk
* `trunk-4c8p` - 4C8P trunk
* `trunk-8c4p` - 8C4P trunk
* `breakout-1c2p-2c1p` - 1C2P:2C1P breakout
* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout
* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout
* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)

# components.schemas.Cable.properties.length_unit.properties.value.description
* `km` - Kilometers
* `m` - Meters
* `cm` - Centimeters
* `mi` - Miles
* `ft` - Feet
* `in` - Inches

# components.schemas.CableRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.CableRequest.properties.type.description
* `cat3` - CAT3
* `cat5` - CAT5
* `cat5e` - CAT5e
* `cat6` - CAT6
* `cat6a` - CAT6a
* `cat7` - CAT7
* `cat7a` - CAT7a
* `cat8` - CAT8
* `mrj21-trunk` - MRJ21 Trunk
* `dac-active` - Direct Attach Copper (Active)
* `dac-passive` - Direct Attach Copper (Passive)
* `coaxial` - Coaxial
* `rg-6` - RG-6
* `rg-8` - RG-8
* `rg-11` - RG-11
* `rg-59` - RG-59
* `rg-62` - RG-62
* `rg-213` - RG-213
* `lmr-100` - LMR-100
* `lmr-200` - LMR-200
* `lmr-400` - LMR-400
* `mmf` - Multimode Fiber
* `mmf-om1` - Multimode Fiber (OM1)
* `mmf-om2` - Multimode Fiber (OM2)
* `mmf-om3` - Multimode Fiber (OM3)
* `mmf-om4` - Multimode Fiber (OM4)
* `mmf-om5` - Multimode Fiber (OM5)
* `smf` - Single-mode Fiber
* `smf-os1` - Single-mode Fiber (OS1)
* `smf-os2` - Single-mode Fiber (OS2)
* `aoc` - Active Optical Cabling (AOC)
* `power` - Power
* `usb` - USB

# components.schemas.CableRequest.properties.status.description
* `connected` - Connected
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.CableRequest.properties.profile.description
* `single-1c1p` - 1C1P
* `single-1c2p` - 1C2P
* `single-1c4p` - 1C4P
* `single-1c6p` - 1C6P
* `single-1c8p` - 1C8P
* `single-1c12p` - 1C12P
* `single-1c16p` - 1C16P
* `trunk-2c1p` - 2C1P trunk
* `trunk-2c2p` - 2C2P trunk
* `trunk-2c4p` - 2C4P trunk
* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)
* `trunk-2c6p` - 2C6P trunk
* `trunk-2c8p` - 2C8P trunk
* `trunk-2c12p` - 2C12P trunk
* `trunk-4c1p` - 4C1P trunk
* `trunk-4c2p` - 4C2P trunk
* `trunk-4c4p` - 4C4P trunk
* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)
* `trunk-4c6p` - 4C6P trunk
* `trunk-4c8p` - 4C8P trunk
* `trunk-8c4p` - 8C4P trunk
* `breakout-1c2p-2c1p` - 1C2P:2C1P breakout
* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout
* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout
* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)

# components.schemas.CableRequest.properties.length_unit.description
* `km` - Kilometers
* `m` - Meters
* `cm` - Centimeters
* `mi` - Miles
* `ft` - Feet
* `in` - Inches

# components.schemas.CableTermination.description
Adds support for custom fields and tags.

# components.schemas.Circuit.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Circuit.properties.status.properties.value.description
* `planned` - Planned
* `provisioning` - Provisioning
* `active` - Active
* `offline` - Offline
* `deprovisioning` - Deprovisioning
* `decommissioned` - Decommissioned

# components.schemas.Circuit.properties.distance_unit.properties.value.description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# components.schemas.CircuitCircuitTermination.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.CircuitCircuitTermination.properties.upstream_speed.description
Upstream speed, if different from port speed

# components.schemas.CircuitCircuitTerminationRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.CircuitCircuitTerminationRequest.properties.upstream_speed.description
Upstream speed, if different from port speed

# components.schemas.CircuitGroup.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.CircuitGroupAssignment.description
Base serializer for group assignments under CircuitSerializer.

# components.schemas.CircuitGroupAssignment.properties.priority.properties.value.description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# components.schemas.CircuitGroupAssignmentRequest.description
Base serializer for group assignments under CircuitSerializer.

# components.schemas.CircuitGroupAssignmentRequest.properties.priority.description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# components.schemas.CircuitGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.CircuitRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.CircuitRequest.properties.status.description
* `planned` - Planned
* `provisioning` - Provisioning
* `active` - Active
* `offline` - Offline
* `deprovisioning` - Deprovisioning
* `decommissioned` - Decommissioned

# components.schemas.CircuitRequest.properties.distance_unit.description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# components.schemas.CircuitTermination.description
Adds support for custom fields and tags.

# components.schemas.CircuitTermination.properties.upstream_speed.description
Upstream speed, if different from port speed

# components.schemas.CircuitTermination.properties.link_peers_type.description
Return the type of the peer link terminations, or None.

# components.schemas.CircuitTerminationRequest.description
Adds support for custom fields and tags.

# components.schemas.CircuitTerminationRequest.properties.upstream_speed.description
Upstream speed, if different from port speed

# components.schemas.CircuitType.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.CircuitTypeRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.Cluster.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Cluster.properties.status.properties.value.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `offline` - Offline

# components.schemas.ClusterGroup.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.ClusterGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.ClusterRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ClusterRequest.properties.status.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `offline` - Offline

# components.schemas.ClusterType.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.ClusterTypeRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.ConfigContext.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ConfigContext.properties.data_path.description
Path to remote file (relative to data source root)

# components.schemas.ConfigContextProfile.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ConfigContextProfile.properties.schema.description
A JSON schema specifying the structure of the context data for this profile

# components.schemas.ConfigContextProfile.properties.data_path.description
Path to remote file (relative to data source root)

# components.schemas.ConfigContextProfileRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ConfigContextProfileRequest.properties.schema.description
A JSON schema specifying the structure of the context data for this profile

# components.schemas.ConfigContextRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ConfigTemplate.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ConfigTemplate.properties.environment_params.description
Any additional parameters to pass when constructing the Jinja environment

# components.schemas.ConfigTemplate.properties.mime_type.description
Defaults to text/plain; charset=utf-8

# components.schemas.ConfigTemplate.properties.file_name.description
Filename to give to the rendered export file

# components.schemas.ConfigTemplate.properties.file_extension.description
Extension to append to the rendered filename

# components.schemas.ConfigTemplate.properties.data_path.description
Path to remote file (relative to data source root)

# components.schemas.ConfigTemplate.properties.auto_sync_enabled.description
Enable automatic synchronization of data when the data file is updated

# components.schemas.ConfigTemplateRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ConfigTemplateRequest.properties.environment_params.description
Any additional parameters to pass when constructing the Jinja environment

# components.schemas.ConfigTemplateRequest.properties.mime_type.description
Defaults to text/plain; charset=utf-8

# components.schemas.ConfigTemplateRequest.properties.file_name.description
Filename to give to the rendered export file

# components.schemas.ConfigTemplateRequest.properties.file_extension.description
Extension to append to the rendered filename

# components.schemas.ConfigTemplateRequest.properties.auto_sync_enabled.description
Enable automatic synchronization of data when the data file is updated

# components.schemas.ConsolePort.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ConsolePort.properties.type.properties.value.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.ConsolePort.properties.link_peers_type.description
Return the type of the peer link terminations, or None.

# components.schemas.ConsolePortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ConsolePortRequest.properties.type.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.ConsolePortTemplate.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.ConsolePortTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.ConsolePortTemplate.properties.type.properties.value.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.ConsolePortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.ConsolePortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.ConsolePortTemplateRequest.properties.type.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.ConsoleServerPort.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ConsoleServerPort.properties.type.properties.value.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.ConsoleServerPort.properties.link_peers_type.description
Return the type of the peer link terminations, or None.

# components.schemas.ConsoleServerPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ConsoleServerPortRequest.properties.type.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.ConsoleServerPortTemplate.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.ConsoleServerPortTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.ConsoleServerPortTemplate.properties.type.properties.value.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.ConsoleServerPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.ConsoleServerPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.ConsoleServerPortTemplateRequest.properties.type.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.Contact.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ContactAssignment.description
Adds support for custom fields and tags.

# components.schemas.ContactAssignment.properties.priority.properties.value.description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# components.schemas.ContactAssignmentRequest.description
Adds support for custom fields and tags.

# components.schemas.ContactAssignmentRequest.properties.priority.description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# components.schemas.ContactGroup.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.ContactGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.ContactRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ContactRole.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.ContactRoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.CustomField.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.CustomField.properties.type.properties.value.description
* `text` - Text
* `longtext` - Text (long)
* `integer` - Integer
* `decimal` - Decimal
* `boolean` - Boolean (true/false)
* `date` - Date
* `datetime` - Date & time
* `url` - URL
* `json` - JSON
* `select` - Selection
* `multiselect` - Multiple selection
* `object` - Object
* `multiobject` - Multiple objects

# components.schemas.CustomField.properties.label.description
Name of the field as displayed to users (if not provided, 'the field's name will be used)

# components.schemas.CustomField.properties.group_name.description
Custom fields within the same group will be displayed together

# components.schemas.CustomField.properties.required.description
This field is required when creating new objects or editing an existing object.

# components.schemas.CustomField.properties.unique.description
The value of this field must be unique for the assigned object

# components.schemas.CustomField.properties.search_weight.description
Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored.

# components.schemas.CustomField.properties.filter_logic.properties.value.description
* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact

# components.schemas.CustomField.properties.ui_visible.properties.value.description
* `always` - Always
* `if-set` - If set
* `hidden` - Hidden

# components.schemas.CustomField.properties.ui_editable.properties.value.description
* `yes` - Yes
* `no` - No
* `hidden` - Hidden

# components.schemas.CustomField.properties.is_cloneable.description
Replicate this value when cloning objects

# components.schemas.CustomField.properties.default.description
Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").

# components.schemas.CustomField.properties.related_object_filter.description
Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo").

# components.schemas.CustomField.properties.weight.description
Fields with higher weights appear lower in a form.

# components.schemas.CustomField.properties.validation_minimum.description
Minimum allowed value (for numeric fields)

# components.schemas.CustomField.properties.validation_maximum.description
Maximum allowed value (for numeric fields)

# components.schemas.CustomField.properties.validation_regex.description
Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.

# components.schemas.CustomFieldChoiceSet.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.CustomFieldChoiceSet.properties.base_choices.properties.value.description
* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)

# components.schemas.CustomFieldChoiceSet.properties.order_alphabetically.description
Choices are automatically ordered alphabetically

# components.schemas.CustomFieldChoiceSetRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.CustomFieldChoiceSetRequest.properties.base_choices.description
* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)

# components.schemas.CustomFieldChoiceSetRequest.properties.order_alphabetically.description
Choices are automatically ordered alphabetically

# components.schemas.CustomFieldRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.CustomFieldRequest.properties.type.description
* `text` - Text
* `longtext` - Text (long)
* `integer` - Integer
* `decimal` - Decimal
* `boolean` - Boolean (true/false)
* `date` - Date
* `datetime` - Date & time
* `url` - URL
* `json` - JSON
* `select` - Selection
* `multiselect` - Multiple selection
* `object` - Object
* `multiobject` - Multiple objects

# components.schemas.CustomFieldRequest.properties.label.description
Name of the field as displayed to users (if not provided, 'the field's name will be used)

# components.schemas.CustomFieldRequest.properties.group_name.description
Custom fields within the same group will be displayed together

# components.schemas.CustomFieldRequest.properties.required.description
This field is required when creating new objects or editing an existing object.

# components.schemas.CustomFieldRequest.properties.unique.description
The value of this field must be unique for the assigned object

# components.schemas.CustomFieldRequest.properties.search_weight.description
Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored.

# components.schemas.CustomFieldRequest.properties.filter_logic.description
* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact

# components.schemas.CustomFieldRequest.properties.ui_visible.description
* `always` - Always
* `if-set` - If set
* `hidden` - Hidden

# components.schemas.CustomFieldRequest.properties.ui_editable.description
* `yes` - Yes
* `no` - No
* `hidden` - Hidden

# components.schemas.CustomFieldRequest.properties.is_cloneable.description
Replicate this value when cloning objects

# components.schemas.CustomFieldRequest.properties.default.description
Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").

# components.schemas.CustomFieldRequest.properties.related_object_filter.description
Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo").

# components.schemas.CustomFieldRequest.properties.weight.description
Fields with higher weights appear lower in a form.

# components.schemas.CustomFieldRequest.properties.validation_minimum.description
Minimum allowed value (for numeric fields)

# components.schemas.CustomFieldRequest.properties.validation_maximum.description
Maximum allowed value (for numeric fields)

# components.schemas.CustomFieldRequest.properties.validation_regex.description
Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.

# components.schemas.CustomLink.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.CustomLink.properties.group_name.description
Links with the same group will appear as a dropdown menu

# components.schemas.CustomLink.properties.button_class.description
The class of the first link in a group will be used for the dropdown button

* `default` - Default
* `blue` - Blue
* `indigo` - Indigo
* `purple` - Purple
* `pink` - Pink
* `red` - Red
* `orange` - Orange
* `yellow` - Yellow
* `green` - Green
* `teal` - Teal
* `cyan` - Cyan
* `gray` - Gray
* `black` - Black
* `white` - White
* `ghost-dark` - Link

# components.schemas.CustomLinkRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.CustomLinkRequest.properties.group_name.description
Links with the same group will appear as a dropdown menu

# components.schemas.CustomLinkRequest.properties.button_class.description
The class of the first link in a group will be used for the dropdown button

* `default` - Default
* `blue` - Blue
* `indigo` - Indigo
* `purple` - Purple
* `pink` - Pink
* `red` - Red
* `orange` - Orange
* `yellow` - Yellow
* `green` - Green
* `teal` - Teal
* `cyan` - Cyan
* `gray` - Gray
* `black` - Black
* `white` - White
* `ghost-dark` - Link

# components.schemas.DataFile.description
Adds support for custom fields and tags.

# components.schemas.DataFile.properties.path.description
File path relative to the data source's root

# components.schemas.DataSource.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.DataSource.properties.status.properties.value.description
* `new` - New
* `queued` - Queued
* `syncing` - Syncing
* `completed` - Completed
* `failed` - Failed

# components.schemas.DataSource.properties.ignore_rules.description
Patterns (one per line) matching files or paths to ignore when syncing

# components.schemas.DataSourceRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.DataSourceRequest.properties.ignore_rules.description
Patterns (one per line) matching files or paths to ignore when syncing

# components.schemas.Device.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Device.properties.serial.description
Chassis serial number, assigned by the manufacturer

# components.schemas.Device.properties.asset_tag.description
A unique tag used to identify this device

# components.schemas.Device.properties.latitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.Device.properties.longitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.Device.properties.status.properties.value.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `inventory` - Inventory
* `decommissioning` - Decommissioning

# components.schemas.Device.properties.airflow.properties.value.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# components.schemas.Device.properties.vc_priority.description
Virtual chassis master election priority

# components.schemas.Device.properties.local_context_data.description
Local config context data takes precedence over source contexts in the final rendered config context

# components.schemas.DeviceBay.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.DeviceBayRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.DeviceBayTemplate.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.DeviceBayTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.DeviceBayTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.DeviceBayTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.DeviceRole.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.DeviceRole.properties.vm_role.description
Virtual machines may be assigned to this role

# components.schemas.DeviceRoleRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.DeviceRoleRequest.properties.vm_role.description
Virtual machines may be assigned to this role

# components.schemas.DeviceType.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.DeviceType.properties.exclude_from_utilization.description
Devices of this type are excluded when calculating rack utilization.

# components.schemas.DeviceType.properties.is_full_depth.description
Device consumes both front and rear rack faces.

# components.schemas.DeviceType.properties.airflow.properties.value.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# components.schemas.DeviceType.properties.weight_unit.properties.value.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.DeviceTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.DeviceTypeRequest.properties.exclude_from_utilization.description
Devices of this type are excluded when calculating rack utilization.

# components.schemas.DeviceTypeRequest.properties.is_full_depth.description
Device consumes both front and rear rack faces.

# components.schemas.DeviceTypeRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# components.schemas.DeviceTypeRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.DeviceWithConfigContext.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.DeviceWithConfigContext.properties.serial.description
Chassis serial number, assigned by the manufacturer

# components.schemas.DeviceWithConfigContext.properties.asset_tag.description
A unique tag used to identify this device

# components.schemas.DeviceWithConfigContext.properties.latitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.DeviceWithConfigContext.properties.longitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.DeviceWithConfigContext.properties.status.properties.value.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `inventory` - Inventory
* `decommissioning` - Decommissioning

# components.schemas.DeviceWithConfigContext.properties.airflow.properties.value.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# components.schemas.DeviceWithConfigContext.properties.vc_priority.description
Virtual chassis master election priority

# components.schemas.DeviceWithConfigContext.properties.local_context_data.description
Local config context data takes precedence over source contexts in the final rendered config context

# components.schemas.DeviceWithConfigContextRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.DeviceWithConfigContextRequest.properties.serial.description
Chassis serial number, assigned by the manufacturer

# components.schemas.DeviceWithConfigContextRequest.properties.asset_tag.description
A unique tag used to identify this device

# components.schemas.DeviceWithConfigContextRequest.properties.latitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.DeviceWithConfigContextRequest.properties.longitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.DeviceWithConfigContextRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `inventory` - Inventory
* `decommissioning` - Decommissioning

# components.schemas.DeviceWithConfigContextRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# components.schemas.DeviceWithConfigContextRequest.properties.vc_priority.description
Virtual chassis master election priority

# components.schemas.DeviceWithConfigContextRequest.properties.local_context_data.description
Local config context data takes precedence over source contexts in the final rendered config context

# components.schemas.EventRule.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.EventRule.properties.event_types.items.description
* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored

# components.schemas.EventRule.properties.event_types.description
The types of event which will trigger this rule.

# components.schemas.EventRule.properties.conditions.description
A set of conditions which determine whether the event will be generated.

# components.schemas.EventRule.properties.action_type.properties.value.description
* `webhook` - Webhook
* `script` - Script
* `notification` - Notification

# components.schemas.EventRuleRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.EventRuleRequest.properties.event_types.items.description
* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored

# components.schemas.EventRuleRequest.properties.event_types.description
The types of event which will trigger this rule.

# components.schemas.EventRuleRequest.properties.conditions.description
A set of conditions which determine whether the event will be generated.

# components.schemas.EventRuleRequest.properties.action_type.description
* `webhook` - Webhook
* `script` - Script
* `notification` - Notification

# components.schemas.ExportTemplate.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ExportTemplate.properties.environment_params.description
Any additional parameters to pass when constructing the Jinja environment

# components.schemas.ExportTemplate.properties.mime_type.description
Defaults to text/plain; charset=utf-8

# components.schemas.ExportTemplate.properties.file_name.description
Filename to give to the rendered export file

# components.schemas.ExportTemplate.properties.file_extension.description
Extension to append to the rendered filename

# components.schemas.ExportTemplate.properties.data_path.description
Path to remote file (relative to data source root)

# components.schemas.ExportTemplateRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ExportTemplateRequest.properties.environment_params.description
Any additional parameters to pass when constructing the Jinja environment

# components.schemas.ExportTemplateRequest.properties.mime_type.description
Defaults to text/plain; charset=utf-8

# components.schemas.ExportTemplateRequest.properties.file_name.description
Filename to give to the rendered export file

# components.schemas.ExportTemplateRequest.properties.file_extension.description
Extension to append to the rendered filename

# components.schemas.FHRPGroup.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.FHRPGroup.properties.protocol.description
* `vrrp2` - VRRPv2
* `vrrp3` - VRRPv3
* `carp` - CARP
* `clusterxl` - ClusterXL
* `hsrp` - HSRP
* `glbp` - GLBP
* `other` - Other

# components.schemas.FHRPGroupAssignment.description
Adds support for custom fields and tags.

# components.schemas.FHRPGroupAssignmentRequest.description
Adds support for custom fields and tags.

# components.schemas.FHRPGroupRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.FHRPGroupRequest.properties.protocol.description
* `vrrp2` - VRRPv2
* `vrrp3` - VRRPv3
* `carp` - CARP
* `clusterxl` - ClusterXL
* `hsrp` - HSRP
* `glbp` - GLBP
* `other` - Other

# components.schemas.FrontPort.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.FrontPort.properties.link_peers_type.description
Return the type of the peer link terminations, or None.

# components.schemas.FrontPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.FrontPortTemplate.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.FrontPortTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.FrontPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.FrontPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.GenericObject.description
Minimal representation of some generic object identified by ContentType and PK.

# components.schemas.GenericObjectRequest.description
Minimal representation of some generic object identified by ContentType and PK.

# components.schemas.Group.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.GroupRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.IKEPolicy.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IKEPolicy.properties.mode.properties.value.description
* `aggressive` - Aggressive
* `main` - Main

# components.schemas.IKEPolicyRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IKEPolicyRequest.properties.mode.description
* `aggressive` - Aggressive
* `main` - Main

# components.schemas.IKEProposal.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IKEProposal.properties.authentication_method.properties.value.description
* `preshared-keys` - Pre-shared keys
* `certificates` - Certificates
* `rsa-signatures` - RSA signatures
* `dsa-signatures` - DSA signatures

# components.schemas.IKEProposal.properties.sa_lifetime.description
Security association lifetime (in seconds)

# components.schemas.IKEProposalRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IKEProposalRequest.properties.authentication_method.description
* `preshared-keys` - Pre-shared keys
* `certificates` - Certificates
* `rsa-signatures` - RSA signatures
* `dsa-signatures` - DSA signatures

# components.schemas.IKEProposalRequest.properties.sa_lifetime.description
Security association lifetime (in seconds)

# components.schemas.IPAddress.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IPAddress.properties.status.properties.value.description
* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated
* `dhcp` - DHCP
* `slaac` - SLAAC

# components.schemas.IPAddress.properties.role.properties.value.description
* `loopback` - Loopback
* `secondary` - Secondary
* `anycast` - Anycast
* `vip` - VIP
* `vrrp` - VRRP
* `hsrp` - HSRP
* `glbp` - GLBP
* `carp` - CARP

# components.schemas.IPAddressRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IPAddressRequest.properties.status.description
* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated
* `dhcp` - DHCP
* `slaac` - SLAAC

# components.schemas.IPAddressRequest.properties.role.description
* `loopback` - Loopback
* `secondary` - Secondary
* `anycast` - Anycast
* `vip` - VIP
* `vrrp` - VRRP
* `hsrp` - HSRP
* `glbp` - GLBP
* `carp` - CARP

# components.schemas.IPRange.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IPRange.properties.status.properties.value.description
* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.IPRange.properties.mark_populated.description
Prevent the creation of IP addresses within this range

# components.schemas.IPRangeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IPRangeRequest.properties.status.description
* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.IPRangeRequest.properties.mark_populated.description
Prevent the creation of IP addresses within this range

# components.schemas.IPSecPolicy.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IPSecPolicyRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IPSecProfile.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IPSecProfileRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IPSecProposal.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IPSecProposal.properties.sa_lifetime_data.description
Security association lifetime (in kilobytes)

# components.schemas.IPSecProposalRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.IPSecProposalRequest.properties.sa_lifetime_data.description
Security association lifetime (in kilobytes)

# components.schemas.ImageAttachment.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.ImageAttachmentRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.Interface.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.Interface.properties.duplex.properties.value.description
* `half` - Half
* `full` - Full
* `auto` - Auto

# components.schemas.Interface.properties.mgmt_only.description
This interface is used only for out-of-band management

# components.schemas.Interface.properties.mode.properties.value.description
* `access` - Access
* `tagged` - Tagged
* `tagged-all` - Tagged (All)
* `q-in-q` - Q-in-Q (802.1ad)

# components.schemas.Interface.properties.rf_role.properties.value.description
* `ap` - Access point
* `station` - Station

# components.schemas.Interface.properties.link_peers_type.description
Return the type of the peer link terminations, or None.

# components.schemas.InterfaceRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.InterfaceRequest.properties.duplex.description
* `half` - Half
* `full` - Full
* `auto` - Auto

# components.schemas.InterfaceRequest.properties.mgmt_only.description
This interface is used only for out-of-band management

# components.schemas.InterfaceRequest.properties.mode.description
* `access` - Access
* `tagged` - Tagged
* `tagged-all` - Tagged (All)
* `q-in-q` - Q-in-Q (802.1ad)

# components.schemas.InterfaceRequest.properties.rf_role.description
* `ap` - Access point
* `station` - Station

# components.schemas.InterfaceTemplate.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.InterfaceTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.InterfaceTemplate.properties.rf_role.properties.value.description
* `ap` - Access point
* `station` - Station

# components.schemas.InterfaceTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.InterfaceTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.InterfaceTemplateRequest.properties.rf_role.description
* `ap` - Access point
* `station` - Station

# components.schemas.InventoryItem.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.InventoryItem.properties.status.properties.value.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning

# components.schemas.InventoryItemRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.InventoryItemRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning

# components.schemas.InventoryItemRole.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.InventoryItemRoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.InventoryItemTemplate.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.InventoryItemTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.InventoryItemTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.InventoryItemTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.Job.properties.status.properties.value.description
* `pending` - Pending
* `scheduled` - Scheduled
* `running` - Running
* `completed` - Completed
* `errored` - Errored
* `failed` - Failed

# components.schemas.Job.properties.queue_name.description
Name of the queue in which this job was enqueued

# components.schemas.JournalEntry.description
Adds support for custom fields and tags.

# components.schemas.JournalEntry.properties.kind.properties.value.description
* `info` - Info
* `success` - Success
* `warning` - Warning
* `danger` - Danger

# components.schemas.JournalEntryRequest.description
Adds support for custom fields and tags.

# components.schemas.JournalEntryRequest.properties.kind.description
* `info` - Info
* `success` - Success
* `warning` - Warning
* `danger` - Danger

# components.schemas.L2VPN.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.L2VPN.properties.type.properties.value.description
* `vpws` - VPWS
* `vpls` - VPLS
* `vxlan` - VXLAN
* `vxlan-evpn` - VXLAN-EVPN
* `mpls-evpn` - MPLS EVPN
* `pbb-evpn` - PBB EVPN
* `evpn-vpws` - EVPN VPWS
* `epl` - EPL
* `evpl` - EVPL
* `ep-lan` - Ethernet Private LAN
* `evp-lan` - Ethernet Virtual Private LAN
* `ep-tree` - Ethernet Private Tree
* `evp-tree` - Ethernet Virtual Private Tree
* `spb` - SPB

# components.schemas.L2VPN.properties.status.properties.value.description
* `active` - Active
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.L2VPNRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.L2VPNRequest.properties.type.description
* `vpws` - VPWS
* `vpls` - VPLS
* `vxlan` - VXLAN
* `vxlan-evpn` - VXLAN-EVPN
* `mpls-evpn` - MPLS EVPN
* `pbb-evpn` - PBB EVPN
* `evpn-vpws` - EVPN VPWS
* `epl` - EPL
* `evpl` - EVPL
* `ep-lan` - Ethernet Private LAN
* `evp-lan` - Ethernet Virtual Private LAN
* `ep-tree` - Ethernet Private Tree
* `evp-tree` - Ethernet Virtual Private Tree
* `spb` - SPB

# components.schemas.L2VPNRequest.properties.status.description
* `active` - Active
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.L2VPNTermination.description
Adds support for custom fields and tags.

# components.schemas.L2VPNTerminationRequest.description
Adds support for custom fields and tags.

# components.schemas.Location.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.Location.properties.status.properties.value.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `retired` - Retired

# components.schemas.LocationRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.LocationRequest.properties.status.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `retired` - Retired

# components.schemas.MACAddress.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.MACAddressRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Manufacturer.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.ManufacturerRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.Module.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Module.properties.status.properties.value.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning

# components.schemas.Module.properties.asset_tag.description
A unique tag used to identify this device

# components.schemas.ModuleBay.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ModuleBay.properties.position.description
Identifier to reference when renaming installed components

# components.schemas.ModuleBayRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.ModuleBayRequest.properties.position.description
Identifier to reference when renaming installed components

# components.schemas.ModuleBayTemplate.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.ModuleBayTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.ModuleBayTemplate.properties.position.description
Identifier to reference when renaming installed components

# components.schemas.ModuleBayTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.ModuleBayTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.ModuleBayTemplateRequest.properties.position.description
Identifier to reference when renaming installed components

# components.schemas.ModuleRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ModuleRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning

# components.schemas.ModuleRequest.properties.asset_tag.description
A unique tag used to identify this device

# components.schemas.ModuleType.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ModuleType.properties.airflow.properties.value.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `passive` - Passive

# components.schemas.ModuleType.properties.weight_unit.properties.value.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.ModuleTypeProfile.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ModuleTypeProfileRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ModuleTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ModuleTypeRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `passive` - Passive

# components.schemas.ModuleTypeRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.NestedContactGroup.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedContactGroupRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedDevice.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedDeviceRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedDeviceRole.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedDeviceRoleRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedGroup.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedIPAddress.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedIPAddressRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedInterface.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedInterfaceRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedInterfaceTemplate.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedInterfaceTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.NestedInterfaceTemplateRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedInterfaceTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.NestedLocation.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedLocationRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedModuleBay.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedModuleBayRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedPlatform.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedPlatformRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedProviderAccount.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedRegion.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedRegionRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedSiteGroup.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedSiteGroupRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedTag.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedTagRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedTenantGroup.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedTenantGroupRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedUser.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedUser.properties.username.description
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# components.schemas.NestedVLAN.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedVLANRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedVMInterface.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedVMInterfaceRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedVirtualMachine.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedVirtualMachineRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedWirelessLANGroup.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedWirelessLANGroupRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedWirelessLink.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.NestedWirelessLinkRequest.description
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a
dictionary of attributes which can be used to uniquely identify the related object. This class should be
subclassed to return a full representation of the related object on read.

# components.schemas.Notification.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.Notification.properties.event_type.description
* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored

# components.schemas.NotificationGroup.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.NotificationGroupRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.NotificationRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.NotificationRequest.properties.event_type.description
* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored

# components.schemas.ObjectChange.properties.action.properties.value.description
* `create` - Created
* `update` - Updated
* `delete` - Deleted

# components.schemas.ObjectPermission.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.ObjectPermission.properties.actions.description
The list of actions granted by this permission

# components.schemas.ObjectPermission.properties.constraints.description
Queryset filter matching the applicable objects of the selected type(s)

# components.schemas.ObjectPermissionRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.ObjectPermissionRequest.properties.actions.description
The list of actions granted by this permission

# components.schemas.ObjectPermissionRequest.properties.constraints.description
Queryset filter matching the applicable objects of the selected type(s)

# components.schemas.Owner.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.OwnerGroup.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.OwnerGroupRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.OwnerRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedASNRangeRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedASNRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedBookmarkRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedCircuitGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedCircuitTerminationRequest.description
Adds support for custom fields and tags.

# components.schemas.PatchedCircuitTerminationRequest.properties.upstream_speed.description
Upstream speed, if different from port speed

# components.schemas.PatchedCircuitTypeRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedClusterGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedClusterTypeRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedConfigContextProfileRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedConfigContextProfileRequest.properties.schema.description
A JSON schema specifying the structure of the context data for this profile

# components.schemas.PatchedConfigContextRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedConfigTemplateRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedConfigTemplateRequest.properties.environment_params.description
Any additional parameters to pass when constructing the Jinja environment

# components.schemas.PatchedConfigTemplateRequest.properties.mime_type.description
Defaults to text/plain; charset=utf-8

# components.schemas.PatchedConfigTemplateRequest.properties.file_name.description
Filename to give to the rendered export file

# components.schemas.PatchedConfigTemplateRequest.properties.file_extension.description
Extension to append to the rendered filename

# components.schemas.PatchedConfigTemplateRequest.properties.auto_sync_enabled.description
Enable automatic synchronization of data when the data file is updated

# components.schemas.PatchedContactRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedContactRoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedCustomLinkRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedCustomLinkRequest.properties.group_name.description
Links with the same group will appear as a dropdown menu

# components.schemas.PatchedCustomLinkRequest.properties.button_class.description
The class of the first link in a group will be used for the dropdown button

* `default` - Default
* `blue` - Blue
* `indigo` - Indigo
* `purple` - Purple
* `pink` - Pink
* `red` - Red
* `orange` - Orange
* `yellow` - Yellow
* `green` - Green
* `teal` - Teal
* `cyan` - Cyan
* `gray` - Gray
* `black` - Black
* `white` - White
* `ghost-dark` - Link

# components.schemas.PatchedDeviceBayRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedDeviceBayTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedDeviceBayTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PatchedExportTemplateRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedExportTemplateRequest.properties.environment_params.description
Any additional parameters to pass when constructing the Jinja environment

# components.schemas.PatchedExportTemplateRequest.properties.mime_type.description
Defaults to text/plain; charset=utf-8

# components.schemas.PatchedExportTemplateRequest.properties.file_name.description
Filename to give to the rendered export file

# components.schemas.PatchedExportTemplateRequest.properties.file_extension.description
Extension to append to the rendered filename

# components.schemas.PatchedFHRPGroupAssignmentRequest.description
Adds support for custom fields and tags.

# components.schemas.PatchedFHRPGroupRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedFHRPGroupRequest.properties.protocol.description
* `vrrp2` - VRRPv2
* `vrrp3` - VRRPv3
* `carp` - CARP
* `clusterxl` - ClusterXL
* `hsrp` - HSRP
* `glbp` - GLBP
* `other` - Other

# components.schemas.PatchedGroupRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedImageAttachmentRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedInventoryItemRoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedInventoryItemTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedInventoryItemTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PatchedL2VPNTerminationRequest.description
Adds support for custom fields and tags.

# components.schemas.PatchedMACAddressRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedManufacturerRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedModuleBayRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedModuleBayRequest.properties.position.description
Identifier to reference when renaming installed components

# components.schemas.PatchedModuleBayTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedModuleBayTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PatchedModuleBayTemplateRequest.properties.position.description
Identifier to reference when renaming installed components

# components.schemas.PatchedModuleTypeProfileRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedNotificationGroupRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedNotificationRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedNotificationRequest.properties.event_type.description
* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored

# components.schemas.PatchedObjectPermissionRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedObjectPermissionRequest.properties.actions.description
The list of actions granted by this permission

# components.schemas.PatchedObjectPermissionRequest.properties.constraints.description
Queryset filter matching the applicable objects of the selected type(s)

# components.schemas.PatchedOwnerGroupRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedOwnerRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedPowerPanelRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedProviderAccountRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedProviderNetworkRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedProviderRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedRIRRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedRIRRequest.properties.is_private.description
IP space managed by this RIR is considered private

# components.schemas.PatchedRackRoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedRoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedRouteTargetRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedRouteTargetRequest.properties.name.description
Route target value (formatted in accordance with RFC 4360)

# components.schemas.PatchedSavedFilterRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedSubscriptionRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedTableConfigRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedTagRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedTenantRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedTokenRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedTokenRequest.properties.enabled.description
Disable to temporarily revoke this token without deleting it.

# components.schemas.PatchedTokenRequest.properties.write_enabled.description
Permit create/update/delete operations using this token

# components.schemas.PatchedTokenRequest.properties.pepper_id.description
ID of the cryptographic pepper used to hash the token (v2 only)

# components.schemas.PatchedTunnelGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedUserRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedUserRequest.properties.username.description
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# components.schemas.PatchedUserRequest.properties.is_active.description
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

# components.schemas.PatchedVLANGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedVLANTranslationPolicyRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedVLANTranslationRuleRequest.description
Adds support for custom fields and tags.

# components.schemas.PatchedVRFRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedVRFRequest.properties.rd.description
Unique route distinguisher (as defined in RFC 4364)

# components.schemas.PatchedVRFRequest.properties.enforce_unique.description
Prevent duplicate prefixes/IP addresses within this VRF

# components.schemas.PatchedVirtualCircuitTypeRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.PatchedVirtualDiskRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWebhookRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWebhookRequest.properties.payload_url.description
This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.

# components.schemas.PatchedWebhookRequest.properties.http_method.description
* `GET` - GET
* `POST` - POST
* `PUT` - PUT
* `PATCH` - PATCH
* `DELETE` - DELETE

# components.schemas.PatchedWebhookRequest.properties.http_content_type.description
The complete list of official content types is available here.

# components.schemas.PatchedWebhookRequest.properties.additional_headers.description
User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).

# components.schemas.PatchedWebhookRequest.properties.body_template.description
Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.

# components.schemas.PatchedWebhookRequest.properties.secret.description
When provided, the request will include a X-Hook-Signature header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.

# components.schemas.PatchedWebhookRequest.properties.ssl_verification.description
Enable SSL certificate verification. Disable with caution!

# components.schemas.PatchedWebhookRequest.properties.ca_file_path.description
The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.

# components.schemas.PatchedWritableAggregateRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableCableRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableCableRequest.properties.type.description
* `cat3` - CAT3
* `cat5` - CAT5
* `cat5e` - CAT5e
* `cat6` - CAT6
* `cat6a` - CAT6a
* `cat7` - CAT7
* `cat7a` - CAT7a
* `cat8` - CAT8
* `mrj21-trunk` - MRJ21 Trunk
* `dac-active` - Direct Attach Copper (Active)
* `dac-passive` - Direct Attach Copper (Passive)
* `coaxial` - Coaxial
* `rg-6` - RG-6
* `rg-8` - RG-8
* `rg-11` - RG-11
* `rg-59` - RG-59
* `rg-62` - RG-62
* `rg-213` - RG-213
* `lmr-100` - LMR-100
* `lmr-200` - LMR-200
* `lmr-400` - LMR-400
* `mmf` - Multimode Fiber
* `mmf-om1` - Multimode Fiber (OM1)
* `mmf-om2` - Multimode Fiber (OM2)
* `mmf-om3` - Multimode Fiber (OM3)
* `mmf-om4` - Multimode Fiber (OM4)
* `mmf-om5` - Multimode Fiber (OM5)
* `smf` - Single-mode Fiber
* `smf-os1` - Single-mode Fiber (OS1)
* `smf-os2` - Single-mode Fiber (OS2)
* `aoc` - Active Optical Cabling (AOC)
* `power` - Power
* `usb` - USB

# components.schemas.PatchedWritableCableRequest.properties.status.description
* `connected` - Connected
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.PatchedWritableCableRequest.properties.profile.description
* `single-1c1p` - 1C1P
* `single-1c2p` - 1C2P
* `single-1c4p` - 1C4P
* `single-1c6p` - 1C6P
* `single-1c8p` - 1C8P
* `single-1c12p` - 1C12P
* `single-1c16p` - 1C16P
* `trunk-2c1p` - 2C1P trunk
* `trunk-2c2p` - 2C2P trunk
* `trunk-2c4p` - 2C4P trunk
* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)
* `trunk-2c6p` - 2C6P trunk
* `trunk-2c8p` - 2C8P trunk
* `trunk-2c12p` - 2C12P trunk
* `trunk-4c1p` - 4C1P trunk
* `trunk-4c2p` - 4C2P trunk
* `trunk-4c4p` - 4C4P trunk
* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)
* `trunk-4c6p` - 4C6P trunk
* `trunk-4c8p` - 4C8P trunk
* `trunk-8c4p` - 8C4P trunk
* `breakout-1c2p-2c1p` - 1C2P:2C1P breakout
* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout
* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout
* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)

# components.schemas.PatchedWritableCableRequest.properties.length_unit.description
* `km` - Kilometers
* `m` - Meters
* `cm` - Centimeters
* `mi` - Miles
* `ft` - Feet
* `in` - Inches

# components.schemas.PatchedWritableCircuitGroupAssignmentRequest.description
Base serializer for group assignments under CircuitSerializer.

# components.schemas.PatchedWritableCircuitGroupAssignmentRequest.properties.priority.description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# components.schemas.PatchedWritableCircuitRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableCircuitRequest.properties.status.description
* `planned` - Planned
* `provisioning` - Provisioning
* `active` - Active
* `offline` - Offline
* `deprovisioning` - Deprovisioning
* `decommissioned` - Decommissioned

# components.schemas.PatchedWritableCircuitRequest.properties.distance_unit.description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# components.schemas.PatchedWritableClusterRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableClusterRequest.properties.status.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `offline` - Offline

# components.schemas.PatchedWritableConsolePortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritableConsolePortRequest.properties.type.description
Physical port type

* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.PatchedWritableConsolePortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedWritableConsolePortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PatchedWritableConsolePortTemplateRequest.properties.type.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.PatchedWritableConsoleServerPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritableConsoleServerPortRequest.properties.type.description
Physical port type

* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.PatchedWritableConsoleServerPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedWritableConsoleServerPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PatchedWritableConsoleServerPortTemplateRequest.properties.type.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.PatchedWritableContactAssignmentRequest.description
Adds support for custom fields and tags.

# components.schemas.PatchedWritableContactAssignmentRequest.properties.priority.description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# components.schemas.PatchedWritableContactGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.PatchedWritableCustomFieldChoiceSetRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritableCustomFieldChoiceSetRequest.properties.base_choices.description
Base set of predefined choices (optional)

* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)

# components.schemas.PatchedWritableCustomFieldChoiceSetRequest.properties.order_alphabetically.description
Choices are automatically ordered alphabetically

# components.schemas.PatchedWritableCustomFieldRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritableCustomFieldRequest.properties.type.description
The type of data this custom field holds

* `text` - Text
* `longtext` - Text (long)
* `integer` - Integer
* `decimal` - Decimal
* `boolean` - Boolean (true/false)
* `date` - Date
* `datetime` - Date & time
* `url` - URL
* `json` - JSON
* `select` - Selection
* `multiselect` - Multiple selection
* `object` - Object
* `multiobject` - Multiple objects

# components.schemas.PatchedWritableCustomFieldRequest.properties.label.description
Name of the field as displayed to users (if not provided, 'the field's name will be used)

# components.schemas.PatchedWritableCustomFieldRequest.properties.group_name.description
Custom fields within the same group will be displayed together

# components.schemas.PatchedWritableCustomFieldRequest.properties.required.description
This field is required when creating new objects or editing an existing object.

# components.schemas.PatchedWritableCustomFieldRequest.properties.unique.description
The value of this field must be unique for the assigned object

# components.schemas.PatchedWritableCustomFieldRequest.properties.search_weight.description
Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored.

# components.schemas.PatchedWritableCustomFieldRequest.properties.filter_logic.description
Loose matches any instance of a given string; exact matches the entire field.

* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact

# components.schemas.PatchedWritableCustomFieldRequest.properties.ui_visible.description
Specifies whether the custom field is displayed in the UI

* `always` - Always
* `if-set` - If set
* `hidden` - Hidden

# components.schemas.PatchedWritableCustomFieldRequest.properties.ui_editable.description
Specifies whether the custom field value can be edited in the UI

* `yes` - Yes
* `no` - No
* `hidden` - Hidden

# components.schemas.PatchedWritableCustomFieldRequest.properties.is_cloneable.description
Replicate this value when cloning objects

# components.schemas.PatchedWritableCustomFieldRequest.properties.default.description
Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").

# components.schemas.PatchedWritableCustomFieldRequest.properties.related_object_filter.description
Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo").

# components.schemas.PatchedWritableCustomFieldRequest.properties.weight.description
Fields with higher weights appear lower in a form.

# components.schemas.PatchedWritableCustomFieldRequest.properties.validation_minimum.description
Minimum allowed value (for numeric fields)

# components.schemas.PatchedWritableCustomFieldRequest.properties.validation_maximum.description
Maximum allowed value (for numeric fields)

# components.schemas.PatchedWritableCustomFieldRequest.properties.validation_regex.description
Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.

# components.schemas.PatchedWritableDataSourceRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableDataSourceRequest.properties.ignore_rules.description
Patterns (one per line) matching files or paths to ignore when syncing

# components.schemas.PatchedWritableDeviceRoleRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.PatchedWritableDeviceRoleRequest.properties.vm_role.description
Virtual machines may be assigned to this role

# components.schemas.PatchedWritableDeviceTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableDeviceTypeRequest.properties.exclude_from_utilization.description
Devices of this type are excluded when calculating rack utilization.

# components.schemas.PatchedWritableDeviceTypeRequest.properties.is_full_depth.description
Device consumes both front and rear rack faces.

# components.schemas.PatchedWritableDeviceTypeRequest.properties.subdevice_role.description
Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.

* `parent` - Parent
* `child` - Child

# components.schemas.PatchedWritableDeviceTypeRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# components.schemas.PatchedWritableDeviceTypeRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.PatchedWritableDeviceWithConfigContextRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableDeviceWithConfigContextRequest.properties.serial.description
Chassis serial number, assigned by the manufacturer

# components.schemas.PatchedWritableDeviceWithConfigContextRequest.properties.asset_tag.description
A unique tag used to identify this device

# components.schemas.PatchedWritableDeviceWithConfigContextRequest.properties.latitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.PatchedWritableDeviceWithConfigContextRequest.properties.longitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.PatchedWritableDeviceWithConfigContextRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `inventory` - Inventory
* `decommissioning` - Decommissioning

# components.schemas.PatchedWritableDeviceWithConfigContextRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# components.schemas.PatchedWritableDeviceWithConfigContextRequest.properties.vc_priority.description
Virtual chassis master election priority

# components.schemas.PatchedWritableDeviceWithConfigContextRequest.properties.local_context_data.description
Local config context data takes precedence over source contexts in the final rendered config context

# components.schemas.PatchedWritableEventRuleRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritableEventRuleRequest.properties.event_types.items.description
* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored

# components.schemas.PatchedWritableEventRuleRequest.properties.event_types.description
The types of event which will trigger this rule.

# components.schemas.PatchedWritableEventRuleRequest.properties.conditions.description
A set of conditions which determine whether the event will be generated.

# components.schemas.PatchedWritableEventRuleRequest.properties.action_type.description
* `webhook` - Webhook
* `script` - Script
* `notification` - Notification

# components.schemas.PatchedWritableFrontPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritableFrontPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedWritableFrontPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PatchedWritableIKEPolicyRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableIKEPolicyRequest.properties.mode.description
* `aggressive` - Aggressive
* `main` - Main

# components.schemas.PatchedWritableIKEProposalRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableIKEProposalRequest.properties.authentication_method.description
* `preshared-keys` - Pre-shared keys
* `certificates` - Certificates
* `rsa-signatures` - RSA signatures
* `dsa-signatures` - DSA signatures

# components.schemas.PatchedWritableIKEProposalRequest.properties.sa_lifetime.description
Security association lifetime (in seconds)

# components.schemas.PatchedWritableIPAddressRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableIPAddressRequest.properties.status.description
The operational status of this IP

* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated
* `dhcp` - DHCP
* `slaac` - SLAAC

# components.schemas.PatchedWritableIPAddressRequest.properties.role.description
The functional role of this IP

* `loopback` - Loopback
* `secondary` - Secondary
* `anycast` - Anycast
* `vip` - VIP
* `vrrp` - VRRP
* `hsrp` - HSRP
* `glbp` - GLBP
* `carp` - CARP

# components.schemas.PatchedWritableIPAddressRequest.properties.nat_inside.description
The IP for which this address is the "outside" IP

# components.schemas.PatchedWritableIPRangeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableIPRangeRequest.properties.status.description
Operational status of this range

* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.PatchedWritableIPRangeRequest.properties.mark_populated.description
Prevent the creation of IP addresses within this range

# components.schemas.PatchedWritableIPSecPolicyRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableIPSecProfileRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableIPSecProposalRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableIPSecProposalRequest.properties.sa_lifetime_data.description
Security association lifetime (in kilobytes)

# components.schemas.PatchedWritableInterfaceRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritableInterfaceRequest.properties.duplex.description
* `half` - Half
* `full` - Full
* `auto` - Auto

# components.schemas.PatchedWritableInterfaceRequest.properties.mgmt_only.description
This interface is used only for out-of-band management

# components.schemas.PatchedWritableInterfaceRequest.properties.mode.description
IEEE 802.1Q tagging strategy

* `access` - Access
* `tagged` - Tagged
* `tagged-all` - Tagged (All)
* `q-in-q` - Q-in-Q (802.1ad)

# components.schemas.PatchedWritableInterfaceRequest.properties.rf_role.description
* `ap` - Access point
* `station` - Station

# components.schemas.PatchedWritableInterfaceTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedWritableInterfaceTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PatchedWritableInterfaceTemplateRequest.properties.rf_role.description
* `ap` - Access point
* `station` - Station

# components.schemas.PatchedWritableInventoryItemRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritableInventoryItemRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning

# components.schemas.PatchedWritableJournalEntryRequest.description
Adds support for custom fields and tags.

# components.schemas.PatchedWritableJournalEntryRequest.properties.kind.description
* `info` - Info
* `success` - Success
* `warning` - Warning
* `danger` - Danger

# components.schemas.PatchedWritableL2VPNRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableL2VPNRequest.properties.type.description
* `vpws` - VPWS
* `vpls` - VPLS
* `vxlan` - VXLAN
* `vxlan-evpn` - VXLAN-EVPN
* `mpls-evpn` - MPLS EVPN
* `pbb-evpn` - PBB EVPN
* `evpn-vpws` - EVPN VPWS
* `epl` - EPL
* `evpl` - EVPL
* `ep-lan` - Ethernet Private LAN
* `evp-lan` - Ethernet Virtual Private LAN
* `ep-tree` - Ethernet Private Tree
* `evp-tree` - Ethernet Virtual Private Tree
* `spb` - SPB

# components.schemas.PatchedWritableL2VPNRequest.properties.status.description
* `active` - Active
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.PatchedWritableLocationRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.PatchedWritableLocationRequest.properties.status.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `retired` - Retired

# components.schemas.PatchedWritableModuleRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableModuleRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning

# components.schemas.PatchedWritableModuleRequest.properties.asset_tag.description
A unique tag used to identify this device

# components.schemas.PatchedWritableModuleTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableModuleTypeRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `passive` - Passive

# components.schemas.PatchedWritableModuleTypeRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.PatchedWritablePlatformRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.PatchedWritablePowerFeedRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritablePowerFeedRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `failed` - Failed

# components.schemas.PatchedWritablePowerFeedRequest.properties.type.description
* `primary` - Primary
* `redundant` - Redundant

# components.schemas.PatchedWritablePowerFeedRequest.properties.phase.description
* `single-phase` - Single phase
* `three-phase` - Three-phase

# components.schemas.PatchedWritablePowerOutletRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritablePowerOutletRequest.properties.status.description
* `enabled` - Enabled
* `disabled` - Disabled
* `faulty` - Faulty

# components.schemas.PatchedWritablePowerOutletRequest.properties.feed_leg.description
Phase (for three-phase feeds)

* `A` - A
* `B` - B
* `C` - C

# components.schemas.PatchedWritablePowerOutletTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedWritablePowerOutletTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PatchedWritablePowerOutletTemplateRequest.properties.feed_leg.description
Phase (for three-phase feeds)

* `A` - A
* `B` - B
* `C` - C

# components.schemas.PatchedWritablePowerPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritablePowerPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedWritablePowerPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PatchedWritablePrefixRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritablePrefixRequest.properties.status.description
Operational status of this prefix

* `container` - Container
* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.PatchedWritablePrefixRequest.properties.is_pool.description
All IP addresses within this prefix are considered usable

# components.schemas.PatchedWritableRackRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableRackRequest.properties.status.description
* `reserved` - Reserved
* `available` - Available
* `planned` - Planned
* `active` - Active
* `deprecated` - Deprecated

# components.schemas.PatchedWritableRackRequest.properties.form_factor.description
* `2-post-frame` - 2-post frame
* `4-post-frame` - 4-post frame
* `4-post-cabinet` - 4-post cabinet
* `wall-frame` - Wall-mounted frame
* `wall-frame-vertical` - Wall-mounted frame (vertical)
* `wall-cabinet` - Wall-mounted cabinet
* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)

# components.schemas.PatchedWritableRackRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.PatchedWritableRackRequest.properties.mounting_depth.description
Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails.

# components.schemas.PatchedWritableRackRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front

# components.schemas.PatchedWritableRackReservationRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableRackReservationRequest.properties.status.description
* `pending` - Pending
* `active` - Active
* `stale` - Stale

# components.schemas.PatchedWritableRackTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableRackTypeRequest.properties.form_factor.description
* `2-post-frame` - 2-post frame
* `4-post-frame` - 4-post frame
* `4-post-cabinet` - 4-post cabinet
* `wall-frame` - Wall-mounted frame
* `wall-frame-vertical` - Wall-mounted frame (vertical)
* `wall-cabinet` - Wall-mounted cabinet
* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)

# components.schemas.PatchedWritableRackTypeRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.PatchedWritableRackTypeRequest.properties.mounting_depth.description
Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails.

# components.schemas.PatchedWritableRearPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritableRearPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PatchedWritableRearPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PatchedWritableRegionRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.PatchedWritableServiceRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableServiceRequest.properties.protocol.description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# components.schemas.PatchedWritableServiceTemplateRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableServiceTemplateRequest.properties.protocol.description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# components.schemas.PatchedWritableSiteGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.PatchedWritableSiteRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableSiteRequest.properties.status.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `retired` - Retired

# components.schemas.PatchedWritableSiteRequest.properties.latitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.PatchedWritableSiteRequest.properties.longitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.PatchedWritableTenantGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.PatchedWritableTunnelRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableTunnelRequest.properties.status.description
* `planned` - Planned
* `active` - Active
* `disabled` - Disabled

# components.schemas.PatchedWritableTunnelRequest.properties.encapsulation.description
* `ipsec-transport` - IPsec - Transport
* `ipsec-tunnel` - IPsec - Tunnel
* `ip-ip` - IP-in-IP
* `gre` - GRE
* `wireguard` - WireGuard
* `openvpn` - OpenVPN
* `l2tp` - L2TP
* `pptp` - PPTP

# components.schemas.PatchedWritableTunnelTerminationRequest.description
Adds support for custom fields and tags.

# components.schemas.PatchedWritableTunnelTerminationRequest.properties.role.description
* `peer` - Peer
* `hub` - Hub
* `spoke` - Spoke

# components.schemas.PatchedWritableVLANRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableVLANRequest.properties.status.description
Operational status of this VLAN

* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.PatchedWritableVLANRequest.properties.qinq_role.description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

* `svlan` - Service
* `cvlan` - Customer

# components.schemas.PatchedWritableVMInterfaceRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PatchedWritableVMInterfaceRequest.properties.mode.description
IEEE 802.1Q tagging strategy

* `access` - Access
* `tagged` - Tagged
* `tagged-all` - Tagged (All)
* `q-in-q` - Q-in-Q (802.1ad)

# components.schemas.PatchedWritableVirtualChassisRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableVirtualCircuitRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableVirtualCircuitRequest.properties.status.description
* `planned` - Planned
* `provisioning` - Provisioning
* `active` - Active
* `offline` - Offline
* `deprovisioning` - Deprovisioning
* `decommissioned` - Decommissioned

# components.schemas.PatchedWritableVirtualCircuitTerminationRequest.description
Adds support for custom fields and tags.

# components.schemas.PatchedWritableVirtualCircuitTerminationRequest.properties.role.description
* `peer` - Peer
* `hub` - Hub
* `spoke` - Spoke

# components.schemas.PatchedWritableVirtualDeviceContextRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableVirtualDeviceContextRequest.properties.status.description
* `active` - Active
* `planned` - Planned
* `offline` - Offline

# components.schemas.PatchedWritableVirtualMachineWithConfigContextRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableVirtualMachineWithConfigContextRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning
* `paused` - Paused

# components.schemas.PatchedWritableVirtualMachineWithConfigContextRequest.properties.start_on_boot.description
* `on` - On
* `off` - Off
* `laststate` - Last State

# components.schemas.PatchedWritableVirtualMachineWithConfigContextRequest.properties.local_context_data.description
Local config context data takes precedence over source contexts in the final rendered config context

# components.schemas.PatchedWritableWirelessLANGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.PatchedWritableWirelessLANRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableWirelessLANRequest.properties.status.description
* `active` - Active
* `reserved` - Reserved
* `disabled` - Disabled
* `deprecated` - Deprecated

# components.schemas.PatchedWritableWirelessLANRequest.properties.auth_type.description
* `open` - Open
* `wep` - WEP
* `wpa-personal` - WPA Personal (PSK)
* `wpa-enterprise` - WPA Enterprise

# components.schemas.PatchedWritableWirelessLANRequest.properties.auth_cipher.description
* `auto` - Auto
* `tkip` - TKIP
* `aes` - AES

# components.schemas.PatchedWritableWirelessLinkRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PatchedWritableWirelessLinkRequest.properties.status.description
* `connected` - Connected
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.PatchedWritableWirelessLinkRequest.properties.auth_type.description
* `open` - Open
* `wep` - WEP
* `wpa-personal` - WPA Personal (PSK)
* `wpa-enterprise` - WPA Enterprise

# components.schemas.PatchedWritableWirelessLinkRequest.properties.auth_cipher.description
* `auto` - Auto
* `tkip` - TKIP
* `aes` - AES

# components.schemas.PatchedWritableWirelessLinkRequest.properties.distance_unit.description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# components.schemas.Platform.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.PlatformRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.PowerFeed.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PowerFeed.properties.status.properties.value.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `failed` - Failed

# components.schemas.PowerFeed.properties.type.properties.value.description
* `primary` - Primary
* `redundant` - Redundant

# components.schemas.PowerFeed.properties.phase.properties.value.description
* `single-phase` - Single phase
* `three-phase` - Three-phase

# components.schemas.PowerFeed.properties.link_peers_type.description
Return the type of the peer link terminations, or None.

# components.schemas.PowerFeedRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PowerFeedRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `failed` - Failed

# components.schemas.PowerFeedRequest.properties.type.description
* `primary` - Primary
* `redundant` - Redundant

# components.schemas.PowerFeedRequest.properties.phase.description
* `single-phase` - Single phase
* `three-phase` - Three-phase

# components.schemas.PowerOutlet.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PowerOutlet.properties.status.properties.value.description
* `enabled` - Enabled
* `disabled` - Disabled
* `faulty` - Faulty

# components.schemas.PowerOutlet.properties.link_peers_type.description
Return the type of the peer link terminations, or None.

# components.schemas.PowerOutletRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PowerOutletRequest.properties.status.description
* `enabled` - Enabled
* `disabled` - Disabled
* `faulty` - Faulty

# components.schemas.PowerOutletTemplate.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PowerOutletTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PowerOutletTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PowerOutletTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PowerPanel.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PowerPanelRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PowerPort.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PowerPort.properties.link_peers_type.description
Return the type of the peer link terminations, or None.

# components.schemas.PowerPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.PowerPortTemplate.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PowerPortTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.PowerPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.PowerPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.Prefix.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Prefix.properties.status.properties.value.description
* `container` - Container
* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.Prefix.properties.is_pool.description
All IP addresses within this prefix are considered usable

# components.schemas.PrefixRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.PrefixRequest.properties.status.description
* `container` - Container
* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.PrefixRequest.properties.is_pool.description
All IP addresses within this prefix are considered usable

# components.schemas.Provider.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ProviderAccount.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ProviderAccountRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ProviderNetwork.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ProviderNetworkRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ProviderRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.RIR.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.RIR.properties.is_private.description
IP space managed by this RIR is considered private

# components.schemas.RIRRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.RIRRequest.properties.is_private.description
IP space managed by this RIR is considered private

# components.schemas.Rack.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Rack.properties.status.properties.value.description
* `reserved` - Reserved
* `available` - Available
* `planned` - Planned
* `active` - Active
* `deprecated` - Deprecated

# components.schemas.Rack.properties.form_factor.properties.value.description
* `2-post-frame` - 2-post frame
* `4-post-frame` - 4-post frame
* `4-post-cabinet` - 4-post cabinet
* `wall-frame` - Wall-mounted frame
* `wall-frame-vertical` - Wall-mounted frame (vertical)
* `wall-cabinet` - Wall-mounted cabinet
* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)

# components.schemas.Rack.properties.weight_unit.properties.value.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.Rack.properties.mounting_depth.description
Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails.

# components.schemas.Rack.properties.airflow.properties.value.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front

# components.schemas.RackRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.RackRequest.properties.status.description
* `reserved` - Reserved
* `available` - Available
* `planned` - Planned
* `active` - Active
* `deprecated` - Deprecated

# components.schemas.RackRequest.properties.form_factor.description
* `2-post-frame` - 2-post frame
* `4-post-frame` - 4-post frame
* `4-post-cabinet` - 4-post cabinet
* `wall-frame` - Wall-mounted frame
* `wall-frame-vertical` - Wall-mounted frame (vertical)
* `wall-cabinet` - Wall-mounted cabinet
* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)

# components.schemas.RackRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.RackRequest.properties.mounting_depth.description
Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails.

# components.schemas.RackRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front

# components.schemas.RackReservation.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.RackReservation.properties.status.properties.value.description
* `pending` - Pending
* `active` - Active
* `stale` - Stale

# components.schemas.RackReservationRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.RackReservationRequest.properties.status.description
* `pending` - Pending
* `active` - Active
* `stale` - Stale

# components.schemas.RackRole.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.RackRoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.RackType.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.RackType.properties.form_factor.properties.value.description
* `2-post-frame` - 2-post frame
* `4-post-frame` - 4-post frame
* `4-post-cabinet` - 4-post cabinet
* `wall-frame` - Wall-mounted frame
* `wall-frame-vertical` - Wall-mounted frame (vertical)
* `wall-cabinet` - Wall-mounted cabinet
* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)

# components.schemas.RackType.properties.weight_unit.properties.value.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.RackType.properties.mounting_depth.description
Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails.

# components.schemas.RackTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.RackTypeRequest.properties.form_factor.description
* `2-post-frame` - 2-post frame
* `4-post-frame` - 4-post frame
* `4-post-cabinet` - 4-post cabinet
* `wall-frame` - Wall-mounted frame
* `wall-frame-vertical` - Wall-mounted frame (vertical)
* `wall-cabinet` - Wall-mounted cabinet
* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)

# components.schemas.RackTypeRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.RackTypeRequest.properties.mounting_depth.description
Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails.

# components.schemas.RackUnit.description
A rack unit is an abstraction formed by the set (rack, position, face); it does not exist as a row in the database.

# components.schemas.RearPort.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.RearPort.properties.link_peers_type.description
Return the type of the peer link terminations, or None.

# components.schemas.RearPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.RearPortTemplate.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.RearPortTemplate.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.RearPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.RearPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.Region.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.RegionRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.Role.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.RoleRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.RouteTarget.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.RouteTarget.properties.name.description
Route target value (formatted in accordance with RFC 4360)

# components.schemas.RouteTargetRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.RouteTargetRequest.properties.name.description
Route target value (formatted in accordance with RFC 4360)

# components.schemas.SavedFilter.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.SavedFilterRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.Script.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.ScriptModule.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.ScriptModuleRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.Service.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Service.properties.protocol.properties.value.description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# components.schemas.ServiceRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ServiceRequest.properties.protocol.description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# components.schemas.ServiceTemplate.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ServiceTemplate.properties.protocol.properties.value.description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# components.schemas.ServiceTemplateRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.ServiceTemplateRequest.properties.protocol.description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# components.schemas.Site.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Site.properties.status.properties.value.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `retired` - Retired

# components.schemas.Site.properties.latitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.Site.properties.longitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.SiteGroup.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.SiteGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.SiteRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.SiteRequest.properties.status.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `retired` - Retired

# components.schemas.SiteRequest.properties.latitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.SiteRequest.properties.longitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.Subscription.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.SubscriptionRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.TableConfig.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.TableConfigRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.Tag.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.TagRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.Tenant.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.TenantGroup.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.TenantGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.TenantRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Token.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.Token.properties.enabled.description
Disable to temporarily revoke this token without deleting it.

# components.schemas.Token.properties.write_enabled.description
Permit create/update/delete operations using this token

# components.schemas.Token.properties.pepper_id.description
ID of the cryptographic pepper used to hash the token (v2 only)

# components.schemas.TokenProvision.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.TokenProvision.properties.enabled.description
Disable to temporarily revoke this token without deleting it.

# components.schemas.TokenProvision.properties.write_enabled.description
Permit create/update/delete operations using this token

# components.schemas.TokenProvisionRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.TokenProvisionRequest.properties.enabled.description
Disable to temporarily revoke this token without deleting it.

# components.schemas.TokenProvisionRequest.properties.write_enabled.description
Permit create/update/delete operations using this token

# components.schemas.TokenRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.TokenRequest.properties.enabled.description
Disable to temporarily revoke this token without deleting it.

# components.schemas.TokenRequest.properties.write_enabled.description
Permit create/update/delete operations using this token

# components.schemas.TokenRequest.properties.pepper_id.description
ID of the cryptographic pepper used to hash the token (v2 only)

# components.schemas.Tunnel.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.Tunnel.properties.status.properties.value.description
* `planned` - Planned
* `active` - Active
* `disabled` - Disabled

# components.schemas.Tunnel.properties.encapsulation.properties.value.description
* `ipsec-transport` - IPsec - Transport
* `ipsec-tunnel` - IPsec - Tunnel
* `ip-ip` - IP-in-IP
* `gre` - GRE
* `wireguard` - WireGuard
* `openvpn` - OpenVPN
* `l2tp` - L2TP
* `pptp` - PPTP

# components.schemas.TunnelGroup.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.TunnelGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.TunnelRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.TunnelRequest.properties.status.description
* `planned` - Planned
* `active` - Active
* `disabled` - Disabled

# components.schemas.TunnelRequest.properties.encapsulation.description
* `ipsec-transport` - IPsec - Transport
* `ipsec-tunnel` - IPsec - Tunnel
* `ip-ip` - IP-in-IP
* `gre` - GRE
* `wireguard` - WireGuard
* `openvpn` - OpenVPN
* `l2tp` - L2TP
* `pptp` - PPTP

# components.schemas.TunnelTermination.description
Adds support for custom fields and tags.

# components.schemas.TunnelTermination.properties.role.properties.value.description
* `peer` - Peer
* `hub` - Hub
* `spoke` - Spoke

# components.schemas.TunnelTerminationRequest.description
Adds support for custom fields and tags.

# components.schemas.TunnelTerminationRequest.properties.role.description
* `peer` - Peer
* `hub` - Hub
* `spoke` - Spoke

# components.schemas.User.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.User.properties.username.description
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# components.schemas.User.properties.is_active.description
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

# components.schemas.UserRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.UserRequest.properties.username.description
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# components.schemas.UserRequest.properties.is_active.description
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

# components.schemas.VLAN.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VLAN.properties.status.properties.value.description
* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.VLAN.properties.qinq_role.properties.value.description
* `svlan` - Service
* `cvlan` - Customer

# components.schemas.VLANGroup.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.VLANGroupRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.VLANRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VLANRequest.properties.status.description
* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.VLANRequest.properties.qinq_role.description
* `svlan` - Service
* `cvlan` - Customer

# components.schemas.VLANTranslationPolicy.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VLANTranslationPolicyRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VLANTranslationRule.description
Adds support for custom fields and tags.

# components.schemas.VLANTranslationRuleRequest.description
Adds support for custom fields and tags.

# components.schemas.VMInterface.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.VMInterface.properties.mode.properties.value.description
* `access` - Access
* `tagged` - Tagged
* `tagged-all` - Tagged (All)
* `q-in-q` - Q-in-Q (802.1ad)

# components.schemas.VMInterfaceRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.VMInterfaceRequest.properties.mode.description
* `access` - Access
* `tagged` - Tagged
* `tagged-all` - Tagged (All)
* `q-in-q` - Q-in-Q (802.1ad)

# components.schemas.VRF.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VRF.properties.rd.description
Unique route distinguisher (as defined in RFC 4364)

# components.schemas.VRF.properties.enforce_unique.description
Prevent duplicate prefixes/IP addresses within this VRF

# components.schemas.VRFRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VRFRequest.properties.rd.description
Unique route distinguisher (as defined in RFC 4364)

# components.schemas.VRFRequest.properties.enforce_unique.description
Prevent duplicate prefixes/IP addresses within this VRF

# components.schemas.VirtualChassis.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VirtualChassisRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VirtualCircuit.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VirtualCircuit.properties.status.properties.value.description
* `planned` - Planned
* `provisioning` - Provisioning
* `active` - Active
* `offline` - Offline
* `deprovisioning` - Deprovisioning
* `decommissioned` - Decommissioned

# components.schemas.VirtualCircuitRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VirtualCircuitRequest.properties.status.description
* `planned` - Planned
* `provisioning` - Provisioning
* `active` - Active
* `offline` - Offline
* `deprovisioning` - Deprovisioning
* `decommissioned` - Decommissioned

# components.schemas.VirtualCircuitTermination.description
Adds support for custom fields and tags.

# components.schemas.VirtualCircuitTermination.properties.role.properties.value.description
* `peer` - Peer
* `hub` - Hub
* `spoke` - Spoke

# components.schemas.VirtualCircuitTerminationRequest.description
Adds support for custom fields and tags.

# components.schemas.VirtualCircuitTerminationRequest.properties.role.description
* `peer` - Peer
* `hub` - Hub
* `spoke` - Spoke

# components.schemas.VirtualCircuitType.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.VirtualCircuitTypeRequest.description
Base serializer class for models inheriting from OrganizationalModel.

# components.schemas.VirtualDeviceContext.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VirtualDeviceContext.properties.status.properties.value.description
* `active` - Active
* `planned` - Planned
* `offline` - Offline

# components.schemas.VirtualDeviceContextRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VirtualDeviceContextRequest.properties.status.description
* `active` - Active
* `planned` - Planned
* `offline` - Offline

# components.schemas.VirtualDisk.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.VirtualDiskRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.VirtualMachineWithConfigContext.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VirtualMachineWithConfigContext.properties.status.properties.value.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning
* `paused` - Paused

# components.schemas.VirtualMachineWithConfigContext.properties.start_on_boot.properties.value.description
* `on` - On
* `off` - Off
* `laststate` - Last State

# components.schemas.VirtualMachineWithConfigContext.properties.local_context_data.description
Local config context data takes precedence over source contexts in the final rendered config context

# components.schemas.VirtualMachineWithConfigContextRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.VirtualMachineWithConfigContextRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning
* `paused` - Paused

# components.schemas.VirtualMachineWithConfigContextRequest.properties.start_on_boot.description
* `on` - On
* `off` - Off
* `laststate` - Last State

# components.schemas.VirtualMachineWithConfigContextRequest.properties.local_context_data.description
Local config context data takes precedence over source contexts in the final rendered config context

# components.schemas.Webhook.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.Webhook.properties.payload_url.description
This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.

# components.schemas.Webhook.properties.http_method.description
* `GET` - GET
* `POST` - POST
* `PUT` - PUT
* `PATCH` - PATCH
* `DELETE` - DELETE

# components.schemas.Webhook.properties.http_content_type.description
The complete list of official content types is available here.

# components.schemas.Webhook.properties.additional_headers.description
User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).

# components.schemas.Webhook.properties.body_template.description
Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.

# components.schemas.Webhook.properties.secret.description
When provided, the request will include a X-Hook-Signature header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.

# components.schemas.Webhook.properties.ssl_verification.description
Enable SSL certificate verification. Disable with caution!

# components.schemas.Webhook.properties.ca_file_path.description
The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.

# components.schemas.WebhookRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WebhookRequest.properties.payload_url.description
This URL will be called using the HTTP method defined when the webhook is called. Jinja2 template processing is supported with the same context as the request body.

# components.schemas.WebhookRequest.properties.http_method.description
* `GET` - GET
* `POST` - POST
* `PUT` - PUT
* `PATCH` - PATCH
* `DELETE` - DELETE

# components.schemas.WebhookRequest.properties.http_content_type.description
The complete list of official content types is available here.

# components.schemas.WebhookRequest.properties.additional_headers.description
User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is supported with the same context as the request body (below).

# components.schemas.WebhookRequest.properties.body_template.description
Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.

# components.schemas.WebhookRequest.properties.secret.description
When provided, the request will include a X-Hook-Signature header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request.

# components.schemas.WebhookRequest.properties.ssl_verification.description
Enable SSL certificate verification. Disable with caution!

# components.schemas.WebhookRequest.properties.ca_file_path.description
The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults.

# components.schemas.WirelessLAN.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WirelessLAN.properties.status.properties.value.description
* `active` - Active
* `reserved` - Reserved
* `disabled` - Disabled
* `deprecated` - Deprecated

# components.schemas.WirelessLAN.properties.auth_type.properties.value.description
* `open` - Open
* `wep` - WEP
* `wpa-personal` - WPA Personal (PSK)
* `wpa-enterprise` - WPA Enterprise

# components.schemas.WirelessLAN.properties.auth_cipher.properties.value.description
* `auto` - Auto
* `tkip` - TKIP
* `aes` - AES

# components.schemas.WirelessLANGroup.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.WirelessLANGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.WirelessLANRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WirelessLANRequest.properties.status.description
* `active` - Active
* `reserved` - Reserved
* `disabled` - Disabled
* `deprecated` - Deprecated

# components.schemas.WirelessLANRequest.properties.auth_type.description
* `open` - Open
* `wep` - WEP
* `wpa-personal` - WPA Personal (PSK)
* `wpa-enterprise` - WPA Enterprise

# components.schemas.WirelessLANRequest.properties.auth_cipher.description
* `auto` - Auto
* `tkip` - TKIP
* `aes` - AES

# components.schemas.WirelessLink.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WirelessLink.properties.status.properties.value.description
* `connected` - Connected
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.WirelessLink.properties.auth_type.properties.value.description
* `open` - Open
* `wep` - WEP
* `wpa-personal` - WPA Personal (PSK)
* `wpa-enterprise` - WPA Enterprise

# components.schemas.WirelessLink.properties.auth_cipher.properties.value.description
* `auto` - Auto
* `tkip` - TKIP
* `aes` - AES

# components.schemas.WirelessLink.properties.distance_unit.properties.value.description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# components.schemas.WirelessLinkRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WirelessLinkRequest.properties.status.description
* `connected` - Connected
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.WirelessLinkRequest.properties.auth_type.description
* `open` - Open
* `wep` - WEP
* `wpa-personal` - WPA Personal (PSK)
* `wpa-enterprise` - WPA Enterprise

# components.schemas.WirelessLinkRequest.properties.auth_cipher.description
* `auto` - Auto
* `tkip` - TKIP
* `aes` - AES

# components.schemas.WirelessLinkRequest.properties.distance_unit.description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# components.schemas.WritableAggregateRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableCableRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableCableRequest.properties.type.description
* `cat3` - CAT3
* `cat5` - CAT5
* `cat5e` - CAT5e
* `cat6` - CAT6
* `cat6a` - CAT6a
* `cat7` - CAT7
* `cat7a` - CAT7a
* `cat8` - CAT8
* `mrj21-trunk` - MRJ21 Trunk
* `dac-active` - Direct Attach Copper (Active)
* `dac-passive` - Direct Attach Copper (Passive)
* `coaxial` - Coaxial
* `rg-6` - RG-6
* `rg-8` - RG-8
* `rg-11` - RG-11
* `rg-59` - RG-59
* `rg-62` - RG-62
* `rg-213` - RG-213
* `lmr-100` - LMR-100
* `lmr-200` - LMR-200
* `lmr-400` - LMR-400
* `mmf` - Multimode Fiber
* `mmf-om1` - Multimode Fiber (OM1)
* `mmf-om2` - Multimode Fiber (OM2)
* `mmf-om3` - Multimode Fiber (OM3)
* `mmf-om4` - Multimode Fiber (OM4)
* `mmf-om5` - Multimode Fiber (OM5)
* `smf` - Single-mode Fiber
* `smf-os1` - Single-mode Fiber (OS1)
* `smf-os2` - Single-mode Fiber (OS2)
* `aoc` - Active Optical Cabling (AOC)
* `power` - Power
* `usb` - USB

# components.schemas.WritableCableRequest.properties.status.description
* `connected` - Connected
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.WritableCableRequest.properties.profile.description
* `single-1c1p` - 1C1P
* `single-1c2p` - 1C2P
* `single-1c4p` - 1C4P
* `single-1c6p` - 1C6P
* `single-1c8p` - 1C8P
* `single-1c12p` - 1C12P
* `single-1c16p` - 1C16P
* `trunk-2c1p` - 2C1P trunk
* `trunk-2c2p` - 2C2P trunk
* `trunk-2c4p` - 2C4P trunk
* `trunk-2c4p-shuffle` - 2C4P trunk (shuffle)
* `trunk-2c6p` - 2C6P trunk
* `trunk-2c8p` - 2C8P trunk
* `trunk-2c12p` - 2C12P trunk
* `trunk-4c1p` - 4C1P trunk
* `trunk-4c2p` - 4C2P trunk
* `trunk-4c4p` - 4C4P trunk
* `trunk-4c4p-shuffle` - 4C4P trunk (shuffle)
* `trunk-4c6p` - 4C6P trunk
* `trunk-4c8p` - 4C8P trunk
* `trunk-8c4p` - 8C4P trunk
* `breakout-1c2p-2c1p` - 1C2P:2C1P breakout
* `breakout-1c4p-4c1p` - 1C4P:4C1P breakout
* `breakout-1c6p-6c1p` - 1C6P:6C1P breakout
* `breakout-2c4p-8c1p-shuffle` - 2C4P:8C1P breakout (shuffle)

# components.schemas.WritableCableRequest.properties.length_unit.description
* `km` - Kilometers
* `m` - Meters
* `cm` - Centimeters
* `mi` - Miles
* `ft` - Feet
* `in` - Inches

# components.schemas.WritableCircuitGroupAssignmentRequest.description
Base serializer for group assignments under CircuitSerializer.

# components.schemas.WritableCircuitGroupAssignmentRequest.properties.priority.description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# components.schemas.WritableCircuitRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableCircuitRequest.properties.status.description
* `planned` - Planned
* `provisioning` - Provisioning
* `active` - Active
* `offline` - Offline
* `deprovisioning` - Deprovisioning
* `decommissioned` - Decommissioned

# components.schemas.WritableCircuitRequest.properties.distance_unit.description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# components.schemas.WritableClusterRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableClusterRequest.properties.status.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `offline` - Offline

# components.schemas.WritableConsolePortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritableConsolePortRequest.properties.type.description
Physical port type

* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.WritableConsolePortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.WritableConsolePortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.WritableConsolePortTemplateRequest.properties.type.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.WritableConsoleServerPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritableConsoleServerPortRequest.properties.type.description
Physical port type

* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.WritableConsoleServerPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.WritableConsoleServerPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.WritableConsoleServerPortTemplateRequest.properties.type.description
* `de-9` - DE-9
* `db-25` - DB-25
* `rj-11` - RJ-11
* `rj-12` - RJ-12
* `rj-45` - RJ-45
* `mini-din-8` - Mini-DIN 8
* `usb-a` - USB Type A
* `usb-b` - USB Type B
* `usb-c` - USB Type C
* `usb-mini-a` - USB Mini A
* `usb-mini-b` - USB Mini B
* `usb-micro-a` - USB Micro A
* `usb-micro-b` - USB Micro B
* `usb-micro-ab` - USB Micro AB
* `other` - Other

# components.schemas.WritableContactAssignmentRequest.description
Adds support for custom fields and tags.

# components.schemas.WritableContactAssignmentRequest.properties.priority.description
* `primary` - Primary
* `secondary` - Secondary
* `tertiary` - Tertiary
* `inactive` - Inactive

# components.schemas.WritableContactGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.WritableCustomFieldChoiceSetRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritableCustomFieldChoiceSetRequest.properties.base_choices.description
Base set of predefined choices (optional)

* `IATA` - IATA (Airport codes)
* `ISO_3166` - ISO 3166 (Country codes)
* `UN_LOCODE` - UN/LOCODE (Location codes)

# components.schemas.WritableCustomFieldChoiceSetRequest.properties.order_alphabetically.description
Choices are automatically ordered alphabetically

# components.schemas.WritableCustomFieldRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritableCustomFieldRequest.properties.type.description
The type of data this custom field holds

* `text` - Text
* `longtext` - Text (long)
* `integer` - Integer
* `decimal` - Decimal
* `boolean` - Boolean (true/false)
* `date` - Date
* `datetime` - Date & time
* `url` - URL
* `json` - JSON
* `select` - Selection
* `multiselect` - Multiple selection
* `object` - Object
* `multiobject` - Multiple objects

# components.schemas.WritableCustomFieldRequest.properties.label.description
Name of the field as displayed to users (if not provided, 'the field's name will be used)

# components.schemas.WritableCustomFieldRequest.properties.group_name.description
Custom fields within the same group will be displayed together

# components.schemas.WritableCustomFieldRequest.properties.required.description
This field is required when creating new objects or editing an existing object.

# components.schemas.WritableCustomFieldRequest.properties.unique.description
The value of this field must be unique for the assigned object

# components.schemas.WritableCustomFieldRequest.properties.search_weight.description
Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored.

# components.schemas.WritableCustomFieldRequest.properties.filter_logic.description
Loose matches any instance of a given string; exact matches the entire field.

* `disabled` - Disabled
* `loose` - Loose
* `exact` - Exact

# components.schemas.WritableCustomFieldRequest.properties.ui_visible.description
Specifies whether the custom field is displayed in the UI

* `always` - Always
* `if-set` - If set
* `hidden` - Hidden

# components.schemas.WritableCustomFieldRequest.properties.ui_editable.description
Specifies whether the custom field value can be edited in the UI

* `yes` - Yes
* `no` - No
* `hidden` - Hidden

# components.schemas.WritableCustomFieldRequest.properties.is_cloneable.description
Replicate this value when cloning objects

# components.schemas.WritableCustomFieldRequest.properties.default.description
Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").

# components.schemas.WritableCustomFieldRequest.properties.related_object_filter.description
Filter the object selection choices using a query_params dict (must be a JSON value).Encapsulate strings with double quotes (e.g. "Foo").

# components.schemas.WritableCustomFieldRequest.properties.weight.description
Fields with higher weights appear lower in a form.

# components.schemas.WritableCustomFieldRequest.properties.validation_minimum.description
Minimum allowed value (for numeric fields)

# components.schemas.WritableCustomFieldRequest.properties.validation_maximum.description
Maximum allowed value (for numeric fields)

# components.schemas.WritableCustomFieldRequest.properties.validation_regex.description
Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters.

# components.schemas.WritableDataSourceRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableDataSourceRequest.properties.ignore_rules.description
Patterns (one per line) matching files or paths to ignore when syncing

# components.schemas.WritableDeviceRoleRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.WritableDeviceRoleRequest.properties.vm_role.description
Virtual machines may be assigned to this role

# components.schemas.WritableDeviceTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableDeviceTypeRequest.properties.exclude_from_utilization.description
Devices of this type are excluded when calculating rack utilization.

# components.schemas.WritableDeviceTypeRequest.properties.is_full_depth.description
Device consumes both front and rear rack faces.

# components.schemas.WritableDeviceTypeRequest.properties.subdevice_role.description
Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.

* `parent` - Parent
* `child` - Child

# components.schemas.WritableDeviceTypeRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# components.schemas.WritableDeviceTypeRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.WritableDeviceWithConfigContextRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableDeviceWithConfigContextRequest.properties.serial.description
Chassis serial number, assigned by the manufacturer

# components.schemas.WritableDeviceWithConfigContextRequest.properties.asset_tag.description
A unique tag used to identify this device

# components.schemas.WritableDeviceWithConfigContextRequest.properties.latitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.WritableDeviceWithConfigContextRequest.properties.longitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.WritableDeviceWithConfigContextRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `inventory` - Inventory
* `decommissioning` - Decommissioning

# components.schemas.WritableDeviceWithConfigContextRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `rear-to-side` - Rear to side
* `bottom-to-top` - Bottom to top
* `top-to-bottom` - Top to bottom
* `passive` - Passive
* `mixed` - Mixed

# components.schemas.WritableDeviceWithConfigContextRequest.properties.vc_priority.description
Virtual chassis master election priority

# components.schemas.WritableDeviceWithConfigContextRequest.properties.local_context_data.description
Local config context data takes precedence over source contexts in the final rendered config context

# components.schemas.WritableEventRuleRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritableEventRuleRequest.properties.event_types.items.description
* `object_created` - Object created
* `object_updated` - Object updated
* `object_deleted` - Object deleted
* `job_started` - Job started
* `job_completed` - Job completed
* `job_failed` - Job failed
* `job_errored` - Job errored

# components.schemas.WritableEventRuleRequest.properties.event_types.description
The types of event which will trigger this rule.

# components.schemas.WritableEventRuleRequest.properties.conditions.description
A set of conditions which determine whether the event will be generated.

# components.schemas.WritableEventRuleRequest.properties.action_type.description
* `webhook` - Webhook
* `script` - Script
* `notification` - Notification

# components.schemas.WritableFrontPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritableFrontPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.WritableFrontPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.WritableIKEPolicyRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableIKEPolicyRequest.properties.mode.description
* `aggressive` - Aggressive
* `main` - Main

# components.schemas.WritableIKEProposalRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableIKEProposalRequest.properties.authentication_method.description
* `preshared-keys` - Pre-shared keys
* `certificates` - Certificates
* `rsa-signatures` - RSA signatures
* `dsa-signatures` - DSA signatures

# components.schemas.WritableIKEProposalRequest.properties.sa_lifetime.description
Security association lifetime (in seconds)

# components.schemas.WritableIPAddressRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableIPAddressRequest.properties.status.description
The operational status of this IP

* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated
* `dhcp` - DHCP
* `slaac` - SLAAC

# components.schemas.WritableIPAddressRequest.properties.role.description
The functional role of this IP

* `loopback` - Loopback
* `secondary` - Secondary
* `anycast` - Anycast
* `vip` - VIP
* `vrrp` - VRRP
* `hsrp` - HSRP
* `glbp` - GLBP
* `carp` - CARP

# components.schemas.WritableIPAddressRequest.properties.nat_inside.description
The IP for which this address is the "outside" IP

# components.schemas.WritableIPRangeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableIPRangeRequest.properties.status.description
Operational status of this range

* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.WritableIPRangeRequest.properties.mark_populated.description
Prevent the creation of IP addresses within this range

# components.schemas.WritableIPSecPolicyRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableIPSecProfileRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableIPSecProposalRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableIPSecProposalRequest.properties.sa_lifetime_data.description
Security association lifetime (in kilobytes)

# components.schemas.WritableInterfaceRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritableInterfaceRequest.properties.duplex.description
* `half` - Half
* `full` - Full
* `auto` - Auto

# components.schemas.WritableInterfaceRequest.properties.mgmt_only.description
This interface is used only for out-of-band management

# components.schemas.WritableInterfaceRequest.properties.mode.description
IEEE 802.1Q tagging strategy

* `access` - Access
* `tagged` - Tagged
* `tagged-all` - Tagged (All)
* `q-in-q` - Q-in-Q (802.1ad)

# components.schemas.WritableInterfaceRequest.properties.rf_role.description
* `ap` - Access point
* `station` - Station

# components.schemas.WritableInterfaceTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.WritableInterfaceTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.WritableInterfaceTemplateRequest.properties.rf_role.description
* `ap` - Access point
* `station` - Station

# components.schemas.WritableInventoryItemRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritableInventoryItemRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning

# components.schemas.WritableJournalEntryRequest.description
Adds support for custom fields and tags.

# components.schemas.WritableJournalEntryRequest.properties.kind.description
* `info` - Info
* `success` - Success
* `warning` - Warning
* `danger` - Danger

# components.schemas.WritableL2VPNRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableL2VPNRequest.properties.type.description
* `vpws` - VPWS
* `vpls` - VPLS
* `vxlan` - VXLAN
* `vxlan-evpn` - VXLAN-EVPN
* `mpls-evpn` - MPLS EVPN
* `pbb-evpn` - PBB EVPN
* `evpn-vpws` - EVPN VPWS
* `epl` - EPL
* `evpl` - EVPL
* `ep-lan` - Ethernet Private LAN
* `evp-lan` - Ethernet Virtual Private LAN
* `ep-tree` - Ethernet Private Tree
* `evp-tree` - Ethernet Virtual Private Tree
* `spb` - SPB

# components.schemas.WritableL2VPNRequest.properties.status.description
* `active` - Active
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.WritableLocationRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.WritableLocationRequest.properties.status.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `retired` - Retired

# components.schemas.WritableModuleRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableModuleRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning

# components.schemas.WritableModuleRequest.properties.asset_tag.description
A unique tag used to identify this device

# components.schemas.WritableModuleTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableModuleTypeRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front
* `left-to-right` - Left to right
* `right-to-left` - Right to left
* `side-to-rear` - Side to rear
* `passive` - Passive

# components.schemas.WritableModuleTypeRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.WritablePlatformRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.WritablePowerFeedRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritablePowerFeedRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `failed` - Failed

# components.schemas.WritablePowerFeedRequest.properties.type.description
* `primary` - Primary
* `redundant` - Redundant

# components.schemas.WritablePowerFeedRequest.properties.phase.description
* `single-phase` - Single phase
* `three-phase` - Three-phase

# components.schemas.WritablePowerOutletRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritablePowerOutletRequest.properties.status.description
* `enabled` - Enabled
* `disabled` - Disabled
* `faulty` - Faulty

# components.schemas.WritablePowerOutletRequest.properties.feed_leg.description
Phase (for three-phase feeds)

* `A` - A
* `B` - B
* `C` - C

# components.schemas.WritablePowerOutletTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.WritablePowerOutletTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.WritablePowerOutletTemplateRequest.properties.feed_leg.description
Phase (for three-phase feeds)

* `A` - A
* `B` - B
* `C` - C

# components.schemas.WritablePowerPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritablePowerPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.WritablePowerPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.WritablePrefixRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritablePrefixRequest.properties.status.description
Operational status of this prefix

* `container` - Container
* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.WritablePrefixRequest.properties.is_pool.description
All IP addresses within this prefix are considered usable

# components.schemas.WritableRackRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableRackRequest.properties.status.description
* `reserved` - Reserved
* `available` - Available
* `planned` - Planned
* `active` - Active
* `deprecated` - Deprecated

# components.schemas.WritableRackRequest.properties.form_factor.description
* `2-post-frame` - 2-post frame
* `4-post-frame` - 4-post frame
* `4-post-cabinet` - 4-post cabinet
* `wall-frame` - Wall-mounted frame
* `wall-frame-vertical` - Wall-mounted frame (vertical)
* `wall-cabinet` - Wall-mounted cabinet
* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)

# components.schemas.WritableRackRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.WritableRackRequest.properties.mounting_depth.description
Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails.

# components.schemas.WritableRackRequest.properties.airflow.description
* `front-to-rear` - Front to rear
* `rear-to-front` - Rear to front

# components.schemas.WritableRackReservationRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableRackReservationRequest.properties.status.description
* `pending` - Pending
* `active` - Active
* `stale` - Stale

# components.schemas.WritableRackTypeRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableRackTypeRequest.properties.form_factor.description
* `2-post-frame` - 2-post frame
* `4-post-frame` - 4-post frame
* `4-post-cabinet` - 4-post cabinet
* `wall-frame` - Wall-mounted frame
* `wall-frame-vertical` - Wall-mounted frame (vertical)
* `wall-cabinet` - Wall-mounted cabinet
* `wall-cabinet-vertical` - Wall-mounted cabinet (vertical)

# components.schemas.WritableRackTypeRequest.properties.weight_unit.description
* `kg` - Kilograms
* `g` - Grams
* `lb` - Pounds
* `oz` - Ounces

# components.schemas.WritableRackTypeRequest.properties.mounting_depth.description
Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails.

# components.schemas.WritableRearPortRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritableRearPortTemplateRequest.description
Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

# components.schemas.WritableRearPortTemplateRequest.properties.name.description
{module} is accepted as a substitution for the module bay position when attached to a module type.

# components.schemas.WritableRegionRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.WritableServiceRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableServiceRequest.properties.protocol.description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# components.schemas.WritableServiceTemplateRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableServiceTemplateRequest.properties.protocol.description
* `tcp` - TCP
* `udp` - UDP
* `sctp` - SCTP

# components.schemas.WritableSiteGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.WritableSiteRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableSiteRequest.properties.status.description
* `planned` - Planned
* `staging` - Staging
* `active` - Active
* `decommissioning` - Decommissioning
* `retired` - Retired

# components.schemas.WritableSiteRequest.properties.latitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.WritableSiteRequest.properties.longitude.description
GPS coordinate in decimal format (xx.yyyyyy)

# components.schemas.WritableTenantGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.WritableTunnelRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableTunnelRequest.properties.status.description
* `planned` - Planned
* `active` - Active
* `disabled` - Disabled

# components.schemas.WritableTunnelRequest.properties.encapsulation.description
* `ipsec-transport` - IPsec - Transport
* `ipsec-tunnel` - IPsec - Tunnel
* `ip-ip` - IP-in-IP
* `gre` - GRE
* `wireguard` - WireGuard
* `openvpn` - OpenVPN
* `l2tp` - L2TP
* `pptp` - PPTP

# components.schemas.WritableTunnelTerminationRequest.description
Adds support for custom fields and tags.

# components.schemas.WritableTunnelTerminationRequest.properties.role.description
* `peer` - Peer
* `hub` - Hub
* `spoke` - Spoke

# components.schemas.WritableVLANRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableVLANRequest.properties.status.description
Operational status of this VLAN

* `active` - Active
* `reserved` - Reserved
* `deprecated` - Deprecated

# components.schemas.WritableVLANRequest.properties.qinq_role.description
Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)

* `svlan` - Service
* `cvlan` - Customer

# components.schemas.WritableVMInterfaceRequest.description
Adds an `owner` field for models which have a ForeignKey to users.Owner.

# components.schemas.WritableVMInterfaceRequest.properties.mode.description
IEEE 802.1Q tagging strategy

* `access` - Access
* `tagged` - Tagged
* `tagged-all` - Tagged (All)
* `q-in-q` - Q-in-Q (802.1ad)

# components.schemas.WritableVirtualChassisRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableVirtualCircuitRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableVirtualCircuitRequest.properties.status.description
* `planned` - Planned
* `provisioning` - Provisioning
* `active` - Active
* `offline` - Offline
* `deprovisioning` - Deprovisioning
* `decommissioned` - Decommissioned

# components.schemas.WritableVirtualCircuitTerminationRequest.description
Adds support for custom fields and tags.

# components.schemas.WritableVirtualCircuitTerminationRequest.properties.role.description
* `peer` - Peer
* `hub` - Hub
* `spoke` - Spoke

# components.schemas.WritableVirtualDeviceContextRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableVirtualDeviceContextRequest.properties.status.description
* `active` - Active
* `planned` - Planned
* `offline` - Offline

# components.schemas.WritableVirtualMachineWithConfigContextRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableVirtualMachineWithConfigContextRequest.properties.status.description
* `offline` - Offline
* `active` - Active
* `planned` - Planned
* `staged` - Staged
* `failed` - Failed
* `decommissioning` - Decommissioning
* `paused` - Paused

# components.schemas.WritableVirtualMachineWithConfigContextRequest.properties.start_on_boot.description
* `on` - On
* `off` - Off
* `laststate` - Last State

# components.schemas.WritableVirtualMachineWithConfigContextRequest.properties.local_context_data.description
Local config context data takes precedence over source contexts in the final rendered config context

# components.schemas.WritableWirelessLANGroupRequest.description
Base serializer class for models inheriting from NestedGroupModel.

# components.schemas.WritableWirelessLANRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableWirelessLANRequest.properties.status.description
* `active` - Active
* `reserved` - Reserved
* `disabled` - Disabled
* `deprecated` - Deprecated

# components.schemas.WritableWirelessLANRequest.properties.auth_type.description
* `open` - Open
* `wep` - WEP
* `wpa-personal` - WPA Personal (PSK)
* `wpa-enterprise` - WPA Enterprise

# components.schemas.WritableWirelessLANRequest.properties.auth_cipher.description
* `auto` - Auto
* `tkip` - TKIP
* `aes` - AES

# components.schemas.WritableWirelessLinkRequest.description
Base serializer class for models inheriting from PrimaryModel.

# components.schemas.WritableWirelessLinkRequest.properties.status.description
* `connected` - Connected
* `planned` - Planned
* `decommissioning` - Decommissioning

# components.schemas.WritableWirelessLinkRequest.properties.auth_type.description
* `open` - Open
* `wep` - WEP
* `wpa-personal` - WPA Personal (PSK)
* `wpa-enterprise` - WPA Enterprise

# components.schemas.WritableWirelessLinkRequest.properties.auth_cipher.description
* `auto` - Auto
* `tkip` - TKIP
* `aes` - AES

# components.schemas.WritableWirelessLinkRequest.properties.distance_unit.description
* `km` - Kilometers
* `m` - Meters
* `mi` - Miles
* `ft` - Feet

# components.securitySchemes.tokenAuth.description
`Token <token>` (v1) or `Bearer <key>.<token>` (v2)