openapi: 3.0.3 info: title: NetBox REST authentication-check dcim API version: 4.5.9 (4.5) license: name: Apache v2 License servers: - url: '' description: NetBox tags: - name: dcim paths: /api/dcim/cable-terminations/: get: operationId: dcim_cable_terminations_list description: Get a list of cable termination objects. parameters: - in: query name: cable schema: type: integer - in: query name: cable__n schema: type: integer - in: query name: cable_end schema: type: string x-spec-enum-id: 1db84f9b93b261c8 title: End enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__empty schema: type: boolean - in: query name: cable_end__ic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__ie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iregex schema: type: array items: type: string explode: true style: form - in: query name: cable_end__isw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__n schema: type: string x-spec-enum-id: 1db84f9b93b261c8 title: End enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__nic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__niew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nisw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: termination_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__empty schema: type: boolean - in: query name: termination_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_type schema: type: array items: type: string explode: true style: form - in: query name: termination_type__n schema: type: array items: type: string explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCableTerminationList' description: '' /api/dcim/cable-terminations/{id}/: get: operationId: dcim_cable_terminations_retrieve description: Get a cable termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cable termination. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CableTermination' description: '' /api/dcim/cables/: get: operationId: dcim_cables_list description: Get a list of cable objects. parameters: - in: query name: circuittermination_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: consoleport_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: consoleserverport_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string explode: true style: form - in: query name: device_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: frontport_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: length schema: type: array items: type: number format: double explode: true style: form - in: query name: length__empty schema: type: boolean - in: query name: length__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: length__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: length__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: length__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: length__n schema: type: array items: type: number format: double explode: true style: form - in: query name: length_unit schema: type: string x-spec-enum-id: 6e7645525ba02462 nullable: true enum: - cm - ft - in - km - m - mi - 'null' description: '* `km` - Kilometers * `m` - Meters * `cm` - Centimeters * `mi` - Miles * `ft` - Feet * `in` - Inches' - in: query name: length_unit__empty schema: type: boolean - in: query name: length_unit__ic schema: type: array items: type: string explode: true style: form - in: query name: length_unit__ie schema: type: array items: type: string explode: true style: form - in: query name: length_unit__iew schema: type: array items: type: string explode: true style: form - in: query name: length_unit__iregex schema: type: array items: type: string explode: true style: form - in: query name: length_unit__isw schema: type: array items: type: string explode: true style: form - in: query name: length_unit__n schema: type: string x-spec-enum-id: 6e7645525ba02462 nullable: true enum: - cm - ft - in - km - m - mi - 'null' description: '* `km` - Kilometers * `m` - Meters * `cm` - Centimeters * `mi` - Miles * `ft` - Feet * `in` - Inches' - in: query name: length_unit__nic schema: type: array items: type: string explode: true style: form - in: query name: length_unit__nie schema: type: array items: type: string explode: true style: form - in: query name: length_unit__niew schema: type: array items: type: string explode: true style: form - in: query name: length_unit__nisw schema: type: array items: type: string explode: true style: form - in: query name: length_unit__regex schema: type: array items: type: string explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string explode: true style: form - in: query name: location_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: powerfeed_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: poweroutlet_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: powerport_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: profile schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: profile__empty schema: type: boolean - in: query name: profile__ic schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: profile__ie schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: profile__iew schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: profile__iregex schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: profile__isw schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: profile__n schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: profile__nic schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: profile__nie schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: profile__niew schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: profile__nisw schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: profile__regex schema: type: array items: type: string x-spec-enum-id: f566e6df6572f5d0 explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string explode: true style: form - in: query name: rack_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rearport_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: site schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 80d251a40f3a3144 explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: termination_a_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_a_type schema: type: array items: type: string explode: true style: form - in: query name: termination_a_type__n schema: type: array items: type: string explode: true style: form - in: query name: termination_b_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_b_type schema: type: array items: type: string explode: true style: form - in: query name: termination_b_type__n schema: type: array items: type: string explode: true style: form - in: query name: type schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true explode: true style: form - in: query name: unterminated schema: type: boolean description: Unterminated - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCableList' description: '' post: operationId: dcim_cables_create description: Post a list of cable objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableCableRequest' - type: array items: $ref: '#/components/schemas/WritableCableRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableCableRequest' - type: array items: $ref: '#/components/schemas/WritableCableRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Cable' description: '' put: operationId: dcim_cables_bulk_update description: Put a list of cable objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CableRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CableRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Cable' description: '' patch: operationId: dcim_cables_bulk_partial_update description: Patch a list of cable objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CableRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CableRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Cable' description: '' delete: operationId: dcim_cables_bulk_destroy description: Delete a list of cable objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CableRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CableRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/cables/{id}/: get: operationId: dcim_cables_retrieve description: Get a cable object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cable. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Cable' description: '' put: operationId: dcim_cables_update description: Put a cable object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cable. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCableRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableCableRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Cable' description: '' patch: operationId: dcim_cables_partial_update description: Patch a cable object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cable. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableCableRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableCableRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Cable' description: '' delete: operationId: dcim_cables_destroy description: Delete a cable object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cable. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/connected-device/: get: operationId: dcim_connected_device_list 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' parameters: - in: query name: peer_device schema: type: string description: The name of the peer device required: true - in: query name: peer_interface schema: type: string description: The name of the peer interface required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Device' description: '' /api/dcim/console-port-templates/: get: operationId: dcim_console_port_templates_list description: Get a list of console port template objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_type_id schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: module_type_id__n schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: q schema: type: string description: Search - in: query name: type schema: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true enum: - Other - Serial - USB - 'null' description: '* `Serial` - [(''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` - [(''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'', ''Other'')]' - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string explode: true style: form - in: query name: type__ie schema: type: array items: type: string explode: true style: form - in: query name: type__iew schema: type: array items: type: string explode: true style: form - in: query name: type__iregex schema: type: array items: type: string explode: true style: form - in: query name: type__isw schema: type: array items: type: string explode: true style: form - in: query name: type__n schema: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true enum: - Other - Serial - USB - 'null' description: '* `Serial` - [(''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` - [(''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'', ''Other'')]' - in: query name: type__nic schema: type: array items: type: string explode: true style: form - in: query name: type__nie schema: type: array items: type: string explode: true style: form - in: query name: type__niew schema: type: array items: type: string explode: true style: form - in: query name: type__nisw schema: type: array items: type: string explode: true style: form - in: query name: type__regex schema: type: array items: type: string explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedConsolePortTemplateList' description: '' post: operationId: dcim_console_port_templates_create description: Post a list of console port template objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableConsolePortTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableConsolePortTemplateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableConsolePortTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableConsolePortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ConsolePortTemplate' description: '' put: operationId: dcim_console_port_templates_bulk_update description: Put a list of console port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsolePortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsolePortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsolePortTemplate' description: '' patch: operationId: dcim_console_port_templates_bulk_partial_update description: Patch a list of console port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsolePortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsolePortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsolePortTemplate' description: '' delete: operationId: dcim_console_port_templates_bulk_destroy description: Delete a list of console port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsolePortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsolePortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/console-port-templates/{id}/: get: operationId: dcim_console_port_templates_retrieve description: Get a console port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console port template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsolePortTemplate' description: '' put: operationId: dcim_console_port_templates_update description: Put a console port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console port template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsolePortTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableConsolePortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsolePortTemplate' description: '' patch: operationId: dcim_console_port_templates_partial_update description: Patch a console port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console port template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableConsolePortTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableConsolePortTemplateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsolePortTemplate' description: '' delete: operationId: dcim_console_port_templates_destroy description: Delete a console port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console port template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/console-ports/: get: operationId: dcim_console_ports_list description: Get a list of console port objects. parameters: - in: query name: cable_connector schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__empty schema: type: boolean - in: query name: cable_connector__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_end schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__empty schema: type: boolean - in: query name: cable_end__ic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__ie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iregex schema: type: array items: type: string explode: true style: form - in: query name: cable_end__isw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__n schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__nic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__niew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nisw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__regex schema: type: array items: type: string explode: true style: form - in: query name: cable_id schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cable_id__n schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cabled schema: type: boolean - in: query name: connected schema: type: boolean - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_role schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role__n schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role_id schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_role_id__n schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_status schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__empty schema: type: boolean - in: query name: device_status__ic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__ie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iregex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__isw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__n schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__niew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nisw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__regex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_type schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type__n schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location__n schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: mark_connected schema: type: boolean - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_id schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: module_id__n schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - in: query name: occupied schema: type: boolean - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack__n schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: speed schema: type: integer x-spec-enum-id: ab6d9635c131a378 nullable: true enum: - 115200 - 1200 - 19200 - 2400 - 38400 - 4800 - 57600 - 9600 - 'null' description: 'Port speed in bits per second * `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' - in: query name: speed__ic schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__ie schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__iew schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__iregex schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__isw schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__n schema: type: integer x-spec-enum-id: ab6d9635c131a378 nullable: true enum: - 115200 - 1200 - 19200 - 2400 - 38400 - 4800 - 57600 - 9600 - 'null' description: 'Port speed in bits per second * `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' - in: query name: speed__nic schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__nie schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__niew schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__nisw schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__regex schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: type schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_chassis schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis__n schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis_id schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form - in: query name: virtual_chassis_id__n schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedConsolePortList' description: '' post: operationId: dcim_console_ports_create description: Post a list of console port objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableConsolePortRequest' - type: array items: $ref: '#/components/schemas/WritableConsolePortRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableConsolePortRequest' - type: array items: $ref: '#/components/schemas/WritableConsolePortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ConsolePort' description: '' put: operationId: dcim_console_ports_bulk_update description: Put a list of console port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsolePortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsolePortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsolePort' description: '' patch: operationId: dcim_console_ports_bulk_partial_update description: Patch a list of console port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsolePortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsolePortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsolePort' description: '' delete: operationId: dcim_console_ports_bulk_destroy description: Delete a list of console port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsolePortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsolePortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/console-ports/{id}/: get: operationId: dcim_console_ports_retrieve description: Get a console port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsolePort' description: '' put: operationId: dcim_console_ports_update description: Put a console port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console port. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsolePortRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableConsolePortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsolePort' description: '' patch: operationId: dcim_console_ports_partial_update description: Patch a console port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console port. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableConsolePortRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableConsolePortRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsolePort' description: '' delete: operationId: dcim_console_ports_destroy description: Delete a console port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/console-ports/{id}/trace/: get: operationId: dcim_console_ports_trace_retrieve description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsolePort' description: '' /api/dcim/console-server-port-templates/: get: operationId: dcim_console_server_port_templates_list description: Get a list of console server port template objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_type_id schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: module_type_id__n schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: q schema: type: string description: Search - in: query name: type schema: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true enum: - Other - Serial - USB - 'null' description: '* `Serial` - [(''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` - [(''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'', ''Other'')]' - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string explode: true style: form - in: query name: type__ie schema: type: array items: type: string explode: true style: form - in: query name: type__iew schema: type: array items: type: string explode: true style: form - in: query name: type__iregex schema: type: array items: type: string explode: true style: form - in: query name: type__isw schema: type: array items: type: string explode: true style: form - in: query name: type__n schema: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true enum: - Other - Serial - USB - 'null' description: '* `Serial` - [(''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` - [(''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'', ''Other'')]' - in: query name: type__nic schema: type: array items: type: string explode: true style: form - in: query name: type__nie schema: type: array items: type: string explode: true style: form - in: query name: type__niew schema: type: array items: type: string explode: true style: form - in: query name: type__nisw schema: type: array items: type: string explode: true style: form - in: query name: type__regex schema: type: array items: type: string explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedConsoleServerPortTemplateList' description: '' post: operationId: dcim_console_server_port_templates_create description: Post a list of console server port template objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ConsoleServerPortTemplate' description: '' put: operationId: dcim_console_server_port_templates_bulk_update description: Put a list of console server port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortTemplate' description: '' patch: operationId: dcim_console_server_port_templates_bulk_partial_update description: Patch a list of console server port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortTemplate' description: '' delete: operationId: dcim_console_server_port_templates_bulk_destroy description: Delete a list of console server port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/console-server-port-templates/{id}/: get: operationId: dcim_console_server_port_templates_retrieve description: Get a console server port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console server port template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleServerPortTemplate' description: '' put: operationId: dcim_console_server_port_templates_update description: Put a console server port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console server port template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleServerPortTemplate' description: '' patch: operationId: dcim_console_server_port_templates_partial_update description: Patch a console server port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console server port template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleServerPortTemplate' description: '' delete: operationId: dcim_console_server_port_templates_destroy description: Delete a console server port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console server port template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/console-server-ports/: get: operationId: dcim_console_server_ports_list description: Get a list of console server port objects. parameters: - in: query name: cable_connector schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__empty schema: type: boolean - in: query name: cable_connector__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_end schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__empty schema: type: boolean - in: query name: cable_end__ic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__ie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iregex schema: type: array items: type: string explode: true style: form - in: query name: cable_end__isw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__n schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__nic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__niew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nisw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__regex schema: type: array items: type: string explode: true style: form - in: query name: cable_id schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cable_id__n schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cabled schema: type: boolean - in: query name: connected schema: type: boolean - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_role schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role__n schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role_id schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_role_id__n schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_status schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__empty schema: type: boolean - in: query name: device_status__ic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__ie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iregex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__isw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__n schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__niew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nisw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__regex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_type schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type__n schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location__n schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: mark_connected schema: type: boolean - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_id schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: module_id__n schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - in: query name: occupied schema: type: boolean - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack__n schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: speed schema: type: integer x-spec-enum-id: ab6d9635c131a378 nullable: true enum: - 115200 - 1200 - 19200 - 2400 - 38400 - 4800 - 57600 - 9600 - 'null' description: 'Port speed in bits per second * `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' - in: query name: speed__ic schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__ie schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__iew schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__iregex schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__isw schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__n schema: type: integer x-spec-enum-id: ab6d9635c131a378 nullable: true enum: - 115200 - 1200 - 19200 - 2400 - 38400 - 4800 - 57600 - 9600 - 'null' description: 'Port speed in bits per second * `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' - in: query name: speed__nic schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__nie schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__niew schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__nisw schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: speed__regex schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: type schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: Physical port type explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_chassis schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis__n schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis_id schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form - in: query name: virtual_chassis_id__n schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedConsoleServerPortList' description: '' post: operationId: dcim_console_server_ports_create description: Post a list of console server port objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableConsoleServerPortRequest' - type: array items: $ref: '#/components/schemas/WritableConsoleServerPortRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableConsoleServerPortRequest' - type: array items: $ref: '#/components/schemas/WritableConsoleServerPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ConsoleServerPort' description: '' put: operationId: dcim_console_server_ports_bulk_update description: Put a list of console server port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPort' description: '' patch: operationId: dcim_console_server_ports_bulk_partial_update description: Patch a list of console server port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPort' description: '' delete: operationId: dcim_console_server_ports_bulk_destroy description: Delete a list of console server port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ConsoleServerPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/console-server-ports/{id}/: get: operationId: dcim_console_server_ports_retrieve description: Get a console server port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console server port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleServerPort' description: '' put: operationId: dcim_console_server_ports_update description: Put a console server port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console server port. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsoleServerPortRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableConsoleServerPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleServerPort' description: '' patch: operationId: dcim_console_server_ports_partial_update description: Patch a console server port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console server port. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableConsoleServerPortRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableConsoleServerPortRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleServerPort' description: '' delete: operationId: dcim_console_server_ports_destroy description: Delete a console server port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console server port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/console-server-ports/{id}/trace/: get: operationId: dcim_console_server_ports_trace_retrieve description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this console server port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsoleServerPort' description: '' /api/dcim/device-bay-templates/: get: operationId: dcim_device_bay_templates_list description: Get a list of device bay template objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: q schema: type: string description: Search - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDeviceBayTemplateList' description: '' post: operationId: dcim_device_bay_templates_create description: Post a list of device bay template objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/DeviceBayTemplateRequest' - type: array items: $ref: '#/components/schemas/DeviceBayTemplateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/DeviceBayTemplateRequest' - type: array items: $ref: '#/components/schemas/DeviceBayTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DeviceBayTemplate' description: '' put: operationId: dcim_device_bay_templates_bulk_update description: Put a list of device bay template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceBayTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceBayTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceBayTemplate' description: '' patch: operationId: dcim_device_bay_templates_bulk_partial_update description: Patch a list of device bay template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceBayTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceBayTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceBayTemplate' description: '' delete: operationId: dcim_device_bay_templates_bulk_destroy description: Delete a list of device bay template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceBayTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceBayTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/device-bay-templates/{id}/: get: operationId: dcim_device_bay_templates_retrieve description: Get a device bay template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device bay template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceBayTemplate' description: '' put: operationId: dcim_device_bay_templates_update description: Put a device bay template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device bay template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceBayTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/DeviceBayTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceBayTemplate' description: '' patch: operationId: dcim_device_bay_templates_partial_update description: Patch a device bay template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device bay template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedDeviceBayTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedDeviceBayTemplateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceBayTemplate' description: '' delete: operationId: dcim_device_bay_templates_destroy description: Delete a device bay template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device bay template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/device-bays/: get: operationId: dcim_device_bays_list description: Get a list of device bay objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_role schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role__n schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role_id schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_role_id__n schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_status schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__empty schema: type: boolean - in: query name: device_status__ic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__ie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iregex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__isw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__n schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__niew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nisw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__regex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_type schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type__n schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: installed_device schema: type: array items: type: string nullable: true description: Installed device (name) explode: true style: form - in: query name: installed_device__n schema: type: array items: type: string nullable: true description: Installed device (name) explode: true style: form - in: query name: installed_device_id schema: type: array items: type: integer nullable: true description: Installed device (ID) explode: true style: form - in: query name: installed_device_id__n schema: type: array items: type: integer nullable: true description: Installed device (ID) explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location__n schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack__n schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_chassis schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis__n schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis_id schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form - in: query name: virtual_chassis_id__n schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDeviceBayList' description: '' post: operationId: dcim_device_bays_create description: Post a list of device bay objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/DeviceBayRequest' - type: array items: $ref: '#/components/schemas/DeviceBayRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/DeviceBayRequest' - type: array items: $ref: '#/components/schemas/DeviceBayRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DeviceBay' description: '' put: operationId: dcim_device_bays_bulk_update description: Put a list of device bay objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceBayRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceBayRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceBay' description: '' patch: operationId: dcim_device_bays_bulk_partial_update description: Patch a list of device bay objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceBayRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceBayRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceBay' description: '' delete: operationId: dcim_device_bays_bulk_destroy description: Delete a list of device bay objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceBayRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceBayRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/device-bays/{id}/: get: operationId: dcim_device_bays_retrieve description: Get a device bay object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device bay. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceBay' description: '' put: operationId: dcim_device_bays_update description: Put a device bay object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device bay. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceBayRequest' multipart/form-data: schema: $ref: '#/components/schemas/DeviceBayRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceBay' description: '' patch: operationId: dcim_device_bays_partial_update description: Patch a device bay object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device bay. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedDeviceBayRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedDeviceBayRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceBay' description: '' delete: operationId: dcim_device_bays_destroy description: Delete a device bay object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device bay. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/device-roles/: get: operationId: dcim_device_roles_list description: Get a list of device role objects. parameters: - in: query name: ancestor schema: type: array items: type: string explode: true style: form - in: query name: ancestor__n schema: type: array items: type: string explode: true style: form - in: query name: ancestor_id schema: type: array items: type: string explode: true style: form - in: query name: ancestor_id__n schema: type: array items: type: string explode: true style: form - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: config_template_id schema: type: array items: type: integer nullable: true description: Config template (ID) explode: true style: form - in: query name: config_template_id__n schema: type: array items: type: integer nullable: true description: Config template (ID) explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent schema: type: array items: type: string description: Parent device role (slug) explode: true style: form - in: query name: parent__n schema: type: array items: type: string description: Parent device role (slug) explode: true style: form - in: query name: parent_id schema: type: array items: type: integer nullable: true description: Parent device role (ID) explode: true style: form - in: query name: parent_id__n schema: type: array items: type: integer nullable: true description: Parent device role (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: vm_role schema: type: boolean tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDeviceRoleList' description: '' post: operationId: dcim_device_roles_create description: Post a list of device role objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableDeviceRoleRequest' - type: array items: $ref: '#/components/schemas/WritableDeviceRoleRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableDeviceRoleRequest' - type: array items: $ref: '#/components/schemas/WritableDeviceRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DeviceRole' description: '' put: operationId: dcim_device_roles_bulk_update description: Put a list of device role objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceRoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceRole' description: '' patch: operationId: dcim_device_roles_bulk_partial_update description: Patch a list of device role objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceRoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceRole' description: '' delete: operationId: dcim_device_roles_bulk_destroy description: Delete a list of device role objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceRoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/device-roles/{id}/: get: operationId: dcim_device_roles_retrieve description: Get a device role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device role. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceRole' description: '' put: operationId: dcim_device_roles_update description: Put a device role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device role. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceRoleRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableDeviceRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceRole' description: '' patch: operationId: dcim_device_roles_partial_update description: Patch a device role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device role. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableDeviceRoleRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableDeviceRoleRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceRole' description: '' delete: operationId: dcim_device_roles_destroy description: Delete a device role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device role. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/device-types/: get: operationId: dcim_device_types_list description: Get a list of device type objects. parameters: - in: query name: airflow schema: type: string x-spec-enum-id: 11cb3d363b41ba9e nullable: true enum: - bottom-to-top - front-to-rear - left-to-right - mixed - 'null' - passive - rear-to-front - rear-to-side - right-to-left - side-to-rear - top-to-bottom 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' - in: query name: airflow__empty schema: type: boolean - in: query name: airflow__ic schema: type: array items: type: string explode: true style: form - in: query name: airflow__ie schema: type: array items: type: string explode: true style: form - in: query name: airflow__iew schema: type: array items: type: string explode: true style: form - in: query name: airflow__iregex schema: type: array items: type: string explode: true style: form - in: query name: airflow__isw schema: type: array items: type: string explode: true style: form - in: query name: airflow__n schema: type: string x-spec-enum-id: 11cb3d363b41ba9e nullable: true enum: - bottom-to-top - front-to-rear - left-to-right - mixed - 'null' - passive - rear-to-front - rear-to-side - right-to-left - side-to-rear - top-to-bottom 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' - in: query name: airflow__nic schema: type: array items: type: string explode: true style: form - in: query name: airflow__nie schema: type: array items: type: string explode: true style: form - in: query name: airflow__niew schema: type: array items: type: string explode: true style: form - in: query name: airflow__nisw schema: type: array items: type: string explode: true style: form - in: query name: airflow__regex schema: type: array items: type: string explode: true style: form - in: query name: console_port_template_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_port_template_count__empty schema: type: boolean - in: query name: console_port_template_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_port_template_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_port_template_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_port_template_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_port_template_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_ports schema: type: boolean description: Has console ports - in: query name: console_server_port_template_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_port_template_count__empty schema: type: boolean - in: query name: console_server_port_template_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_port_template_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_port_template_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_port_template_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_port_template_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_ports schema: type: boolean description: Has console server ports - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: default_platform schema: type: array items: type: string explode: true style: form - in: query name: default_platform__n schema: type: array items: type: string explode: true style: form - in: query name: default_platform_id schema: type: array items: type: string explode: true style: form - in: query name: default_platform_id__n schema: type: array items: type: string explode: true style: form - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_bay_template_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bay_template_count__empty schema: type: boolean - in: query name: device_bay_template_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bay_template_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bay_template_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bay_template_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bay_template_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bays schema: type: boolean description: Has device bays - in: query name: device_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_count__empty schema: type: boolean - in: query name: device_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: exclude_from_utilization schema: type: boolean - in: query name: front_port_template_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: front_port_template_count__empty schema: type: boolean - in: query name: front_port_template_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: front_port_template_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: front_port_template_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: front_port_template_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: front_port_template_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: has_front_image schema: type: boolean description: Has a front image - in: query name: has_rear_image schema: type: boolean description: Has a rear image - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_template_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_template_count__empty schema: type: boolean - in: query name: interface_template_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_template_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_template_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_template_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_template_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interfaces schema: type: boolean description: Has interfaces - in: query name: inventory_item_template_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: inventory_item_template_count__empty schema: type: boolean - in: query name: inventory_item_template_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: inventory_item_template_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: inventory_item_template_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: inventory_item_template_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: inventory_item_template_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: inventory_items schema: type: boolean description: Has inventory items - in: query name: is_full_depth schema: type: boolean - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: manufacturer schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer__n schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer_id schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: manufacturer_id__n schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: model schema: type: array items: type: string explode: true style: form - in: query name: model__empty schema: type: boolean - in: query name: model__ic schema: type: array items: type: string explode: true style: form - in: query name: model__ie schema: type: array items: type: string explode: true style: form - in: query name: model__iew schema: type: array items: type: string explode: true style: form - in: query name: model__iregex schema: type: array items: type: string explode: true style: form - in: query name: model__isw schema: type: array items: type: string explode: true style: form - in: query name: model__n schema: type: array items: type: string explode: true style: form - in: query name: model__nic schema: type: array items: type: string explode: true style: form - in: query name: model__nie schema: type: array items: type: string explode: true style: form - in: query name: model__niew schema: type: array items: type: string explode: true style: form - in: query name: model__nisw schema: type: array items: type: string explode: true style: form - in: query name: model__regex schema: type: array items: type: string explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_bay_template_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bay_template_count__empty schema: type: boolean - in: query name: module_bay_template_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bay_template_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bay_template_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bay_template_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bay_template_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bays schema: type: boolean description: Has module bays - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: part_number schema: type: array items: type: string explode: true style: form - in: query name: part_number__empty schema: type: boolean - in: query name: part_number__ic schema: type: array items: type: string explode: true style: form - in: query name: part_number__ie schema: type: array items: type: string explode: true style: form - in: query name: part_number__iew schema: type: array items: type: string explode: true style: form - in: query name: part_number__iregex schema: type: array items: type: string explode: true style: form - in: query name: part_number__isw schema: type: array items: type: string explode: true style: form - in: query name: part_number__n schema: type: array items: type: string explode: true style: form - in: query name: part_number__nic schema: type: array items: type: string explode: true style: form - in: query name: part_number__nie schema: type: array items: type: string explode: true style: form - in: query name: part_number__niew schema: type: array items: type: string explode: true style: form - in: query name: part_number__nisw schema: type: array items: type: string explode: true style: form - in: query name: part_number__regex schema: type: array items: type: string explode: true style: form - in: query name: pass_through_ports schema: type: boolean description: Has pass-through ports - in: query name: power_outlet_template_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlet_template_count__empty schema: type: boolean - in: query name: power_outlet_template_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlet_template_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlet_template_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlet_template_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlet_template_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlets schema: type: boolean description: Has power outlets - in: query name: power_port_template_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_port_template_count__empty schema: type: boolean - in: query name: power_port_template_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_port_template_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_port_template_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_port_template_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_port_template_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_ports schema: type: boolean description: Has power ports - in: query name: q schema: type: string description: Search - in: query name: rear_port_template_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rear_port_template_count__empty schema: type: boolean - in: query name: rear_port_template_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rear_port_template_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rear_port_template_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rear_port_template_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rear_port_template_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: subdevice_role schema: type: string x-spec-enum-id: 65a61d5e1deb4a24 nullable: true title: Parent/child status enum: - child - 'null' - parent 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' - in: query name: subdevice_role__empty schema: type: boolean - in: query name: subdevice_role__ic schema: type: array items: type: string explode: true style: form - in: query name: subdevice_role__ie schema: type: array items: type: string explode: true style: form - in: query name: subdevice_role__iew schema: type: array items: type: string explode: true style: form - in: query name: subdevice_role__iregex schema: type: array items: type: string explode: true style: form - in: query name: subdevice_role__isw schema: type: array items: type: string explode: true style: form - in: query name: subdevice_role__n schema: type: string x-spec-enum-id: 65a61d5e1deb4a24 nullable: true title: Parent/child status enum: - child - 'null' - parent 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' - in: query name: subdevice_role__nic schema: type: array items: type: string explode: true style: form - in: query name: subdevice_role__nie schema: type: array items: type: string explode: true style: form - in: query name: subdevice_role__niew schema: type: array items: type: string explode: true style: form - in: query name: subdevice_role__nisw schema: type: array items: type: string explode: true style: form - in: query name: subdevice_role__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: u_height schema: type: array items: type: number format: double explode: true style: form - in: query name: u_height__empty schema: type: boolean - in: query name: u_height__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: u_height__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: u_height__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: u_height__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: u_height__n schema: type: array items: type: number format: double explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: weight schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__empty schema: type: boolean - in: query name: weight__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__n schema: type: array items: type: number format: double explode: true style: form - in: query name: weight_unit schema: type: string x-spec-enum-id: 2235ce3f404afbc0 nullable: true enum: - g - kg - lb - 'null' - oz description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' - in: query name: weight_unit__empty schema: type: boolean - in: query name: weight_unit__ic schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__ie schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__iew schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__iregex schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__isw schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__n schema: type: string x-spec-enum-id: 2235ce3f404afbc0 nullable: true enum: - g - kg - lb - 'null' - oz description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' - in: query name: weight_unit__nic schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__nie schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__niew schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__nisw schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__regex schema: type: array items: type: string explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDeviceTypeList' description: '' post: operationId: dcim_device_types_create description: Post a list of device type objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableDeviceTypeRequest' - type: array items: $ref: '#/components/schemas/WritableDeviceTypeRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableDeviceTypeRequest' - type: array items: $ref: '#/components/schemas/WritableDeviceTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DeviceType' description: '' put: operationId: dcim_device_types_bulk_update description: Put a list of device type objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceType' description: '' patch: operationId: dcim_device_types_bulk_partial_update description: Patch a list of device type objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceType' description: '' delete: operationId: dcim_device_types_bulk_destroy description: Delete a list of device type objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/device-types/{id}/: get: operationId: dcim_device_types_retrieve description: Get a device type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device type. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceType' description: '' put: operationId: dcim_device_types_update description: Put a device type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device type. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableDeviceTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceType' description: '' patch: operationId: dcim_device_types_partial_update description: Patch a device type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device type. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableDeviceTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableDeviceTypeRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceType' description: '' delete: operationId: dcim_device_types_destroy description: Delete a device type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device type. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/devices/: get: operationId: dcim_devices_list description: Get a list of device objects. parameters: - in: query name: airflow schema: type: string x-spec-enum-id: 11cb3d363b41ba9e nullable: true enum: - bottom-to-top - front-to-rear - left-to-right - mixed - 'null' - passive - rear-to-front - rear-to-side - right-to-left - side-to-rear - top-to-bottom 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' - in: query name: airflow__empty schema: type: boolean - in: query name: airflow__ic schema: type: array items: type: string explode: true style: form - in: query name: airflow__ie schema: type: array items: type: string explode: true style: form - in: query name: airflow__iew schema: type: array items: type: string explode: true style: form - in: query name: airflow__iregex schema: type: array items: type: string explode: true style: form - in: query name: airflow__isw schema: type: array items: type: string explode: true style: form - in: query name: airflow__n schema: type: string x-spec-enum-id: 11cb3d363b41ba9e nullable: true enum: - bottom-to-top - front-to-rear - left-to-right - mixed - 'null' - passive - rear-to-front - rear-to-side - right-to-left - side-to-rear - top-to-bottom 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' - in: query name: airflow__nic schema: type: array items: type: string explode: true style: form - in: query name: airflow__nie schema: type: array items: type: string explode: true style: form - in: query name: airflow__niew schema: type: array items: type: string explode: true style: form - in: query name: airflow__nisw schema: type: array items: type: string explode: true style: form - in: query name: airflow__regex schema: type: array items: type: string explode: true style: form - in: query name: asset_tag schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__empty schema: type: boolean - in: query name: asset_tag__ic schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__ie schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__iew schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__iregex schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__isw schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__n schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nic schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nie schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__niew schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nisw schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__regex schema: type: array items: type: string explode: true style: form - in: query name: cluster_group schema: type: array items: type: string description: Cluster group (slug) explode: true style: form - in: query name: cluster_group__n schema: type: array items: type: string description: Cluster group (slug) explode: true style: form - in: query name: cluster_group_id schema: type: array items: type: integer description: Cluster group (ID) explode: true style: form - in: query name: cluster_group_id__n schema: type: array items: type: integer description: Cluster group (ID) explode: true style: form - in: query name: cluster_id schema: type: array items: type: integer nullable: true description: VM cluster (ID) explode: true style: form - in: query name: cluster_id__n schema: type: array items: type: integer nullable: true description: VM cluster (ID) explode: true style: form - in: query name: config_template_id schema: type: array items: type: integer nullable: true description: Config template (ID) explode: true style: form - in: query name: config_template_id__n schema: type: array items: type: integer nullable: true description: Config template (ID) explode: true style: form - in: query name: console_port_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_port_count__empty schema: type: boolean - in: query name: console_port_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_port_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_port_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_port_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_port_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_ports schema: type: boolean description: Has console ports - in: query name: console_server_port_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_port_count__empty schema: type: boolean - in: query name: console_server_port_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_port_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_port_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_port_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_port_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: console_server_ports schema: type: boolean description: Has console server ports - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_bay_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bay_count__empty schema: type: boolean - in: query name: device_bay_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bay_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bay_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bay_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bay_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: device_bays schema: type: boolean description: Has device bays - in: query name: device_type schema: type: array items: type: string description: Device type (slug) explode: true style: form - in: query name: device_type__n schema: type: array items: type: string description: Device type (slug) explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: face schema: type: string x-spec-enum-id: d2fb9b3f75158b83 nullable: true title: Rack face enum: - front - 'null' - rear description: '* `front` - Front * `rear` - Rear' - in: query name: face__empty schema: type: boolean - in: query name: face__ic schema: type: array items: type: string explode: true style: form - in: query name: face__ie schema: type: array items: type: string explode: true style: form - in: query name: face__iew schema: type: array items: type: string explode: true style: form - in: query name: face__iregex schema: type: array items: type: string explode: true style: form - in: query name: face__isw schema: type: array items: type: string explode: true style: form - in: query name: face__n schema: type: string x-spec-enum-id: d2fb9b3f75158b83 nullable: true title: Rack face enum: - front - 'null' - rear description: '* `front` - Front * `rear` - Rear' - in: query name: face__nic schema: type: array items: type: string explode: true style: form - in: query name: face__nie schema: type: array items: type: string explode: true style: form - in: query name: face__niew schema: type: array items: type: string explode: true style: form - in: query name: face__nisw schema: type: array items: type: string explode: true style: form - in: query name: face__regex schema: type: array items: type: string explode: true style: form - in: query name: front_port_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: front_port_count__empty schema: type: boolean - in: query name: front_port_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: front_port_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: front_port_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: front_port_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: front_port_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: has_oob_ip schema: type: boolean description: Has an out-of-band IP - in: query name: has_primary_ip schema: type: boolean description: Has a primary IP - in: query name: has_virtual_device_context schema: type: boolean description: Has virtual device context - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_count__empty schema: type: boolean - in: query name: interface_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interfaces schema: type: boolean description: Has interfaces - in: query name: inventory_item_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: inventory_item_count__empty schema: type: boolean - in: query name: inventory_item_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: inventory_item_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: inventory_item_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: inventory_item_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: inventory_item_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: is_full_depth schema: type: boolean description: Is full depth - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: latitude schema: type: array items: type: number format: double explode: true style: form - in: query name: latitude__empty schema: type: boolean - in: query name: latitude__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: latitude__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: latitude__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: latitude__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: latitude__n schema: type: array items: type: number format: double explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: local_context_data schema: type: boolean description: Has local config context data - in: query name: location schema: type: array items: type: string explode: true style: form - in: query name: location__n schema: type: array items: type: string explode: true style: form - in: query name: location_id schema: type: array items: type: string explode: true style: form - in: query name: location_id__n schema: type: array items: type: string explode: true style: form - in: query name: longitude schema: type: array items: type: number format: double explode: true style: form - in: query name: longitude__empty schema: type: boolean - in: query name: longitude__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: longitude__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: longitude__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: longitude__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: longitude__n schema: type: array items: type: number format: double explode: true style: form - in: query name: mac_address schema: type: array items: type: string explode: true style: form - in: query name: mac_address__ic schema: type: array items: type: string explode: true style: form - in: query name: mac_address__ie schema: type: array items: type: string explode: true style: form - in: query name: mac_address__iew schema: type: array items: type: string explode: true style: form - in: query name: mac_address__iregex schema: type: array items: type: string explode: true style: form - in: query name: mac_address__isw schema: type: array items: type: string explode: true style: form - in: query name: mac_address__n schema: type: array items: type: string explode: true style: form - in: query name: mac_address__nic schema: type: array items: type: string explode: true style: form - in: query name: mac_address__nie schema: type: array items: type: string explode: true style: form - in: query name: mac_address__niew schema: type: array items: type: string explode: true style: form - in: query name: mac_address__nisw schema: type: array items: type: string explode: true style: form - in: query name: mac_address__regex schema: type: array items: type: string explode: true style: form - in: query name: manufacturer schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer__n schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer_id schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: manufacturer_id__n schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: model schema: type: array items: type: string description: Device model (slug) explode: true style: form - in: query name: model__n schema: type: array items: type: string description: Device model (slug) explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_bay_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bay_count__empty schema: type: boolean - in: query name: module_bay_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bay_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bay_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bay_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bay_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_bays schema: type: boolean description: Has module bays - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: oob_ip_id schema: type: array items: type: integer description: OOB IP (ID) explode: true style: form - in: query name: oob_ip_id__n schema: type: array items: type: integer description: OOB IP (ID) explode: true style: form - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent_bay_id schema: type: array items: type: integer description: Parent bay (ID) explode: true style: form - in: query name: parent_bay_id__n schema: type: array items: type: integer description: Parent bay (ID) explode: true style: form - in: query name: parent_device_id schema: type: array items: type: integer description: Parent Device (ID) explode: true style: form - in: query name: parent_device_id__n schema: type: array items: type: integer description: Parent Device (ID) explode: true style: form - in: query name: pass_through_ports schema: type: boolean description: Has pass-through ports - in: query name: platform schema: type: array items: type: string explode: true style: form - in: query name: platform__n schema: type: array items: type: string explode: true style: form - in: query name: platform_id schema: type: array items: type: string explode: true style: form - in: query name: platform_id__n schema: type: array items: type: string explode: true style: form - in: query name: position schema: type: array items: type: number format: double explode: true style: form - in: query name: position__empty schema: type: boolean - in: query name: position__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: position__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: position__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: position__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: position__n schema: type: array items: type: number format: double explode: true style: form - in: query name: power_outlet_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlet_count__empty schema: type: boolean - in: query name: power_outlet_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlet_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlet_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlet_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlet_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_outlets schema: type: boolean description: Has power outlets - in: query name: power_port_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_port_count__empty schema: type: boolean - in: query name: power_port_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_port_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_port_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_port_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_port_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: power_ports schema: type: boolean description: Has power ports - in: query name: primary_ip4 schema: type: array items: type: string description: Primary IPv4 (address) explode: true style: form - in: query name: primary_ip4__n schema: type: array items: type: string description: Primary IPv4 (address) explode: true style: form - in: query name: primary_ip4_id schema: type: array items: type: integer description: Primary IPv4 (ID) explode: true style: form - in: query name: primary_ip4_id__n schema: type: array items: type: integer description: Primary IPv4 (ID) explode: true style: form - in: query name: primary_ip6 schema: type: array items: type: string description: Primary IPv6 (address) explode: true style: form - in: query name: primary_ip6__n schema: type: array items: type: string description: Primary IPv6 (address) explode: true style: form - in: query name: primary_ip6_id schema: type: array items: type: integer description: Primary IPv6 (ID) explode: true style: form - in: query name: primary_ip6_id__n schema: type: array items: type: integer description: Primary IPv6 (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rear_port_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rear_port_count__empty schema: type: boolean - in: query name: rear_port_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rear_port_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rear_port_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rear_port_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rear_port_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: role schema: type: array items: type: string explode: true style: form - in: query name: role__n schema: type: array items: type: string explode: true style: form - in: query name: role_id schema: type: array items: type: string explode: true style: form - in: query name: role_id__n schema: type: array items: type: string explode: true style: form - in: query name: serial schema: type: array items: type: string explode: true style: form - in: query name: serial__empty schema: type: boolean - in: query name: serial__ic schema: type: array items: type: string explode: true style: form - in: query name: serial__ie schema: type: array items: type: string explode: true style: form - in: query name: serial__iew schema: type: array items: type: string explode: true style: form - in: query name: serial__iregex schema: type: array items: type: string explode: true style: form - in: query name: serial__isw schema: type: array items: type: string explode: true style: form - in: query name: serial__n schema: type: array items: type: string explode: true style: form - in: query name: serial__nic schema: type: array items: type: string explode: true style: form - in: query name: serial__nie schema: type: array items: type: string explode: true style: form - in: query name: serial__niew schema: type: array items: type: string explode: true style: form - in: query name: serial__nisw schema: type: array items: type: string explode: true style: form - in: query name: serial__regex schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: vc_position schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vc_position__empty schema: type: boolean - in: query name: vc_position__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vc_position__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vc_position__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vc_position__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vc_position__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vc_priority schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vc_priority__empty schema: type: boolean - in: query name: vc_priority__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vc_priority__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vc_priority__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vc_priority__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vc_priority__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: virtual_chassis_id schema: type: array items: type: integer description: Virtual chassis (ID) explode: true style: form - in: query name: virtual_chassis_id__n schema: type: array items: type: integer description: Virtual chassis (ID) explode: true style: form - in: query name: virtual_chassis_member schema: type: boolean description: Is a virtual chassis member tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDeviceWithConfigContextList' description: '' post: operationId: dcim_devices_create description: Post a list of device objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' - type: array items: $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' - type: array items: $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/DeviceWithConfigContext' description: '' put: operationId: dcim_devices_bulk_update description: Put a list of device objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceWithConfigContextRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceWithConfigContext' description: '' patch: operationId: dcim_devices_bulk_partial_update description: Patch a list of device objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceWithConfigContextRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceWithConfigContext' description: '' delete: operationId: dcim_devices_bulk_destroy description: Delete a list of device objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceWithConfigContextRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/DeviceWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/devices/{id}/: get: operationId: dcim_devices_retrieve description: Get a device object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceWithConfigContext' description: '' put: operationId: dcim_devices_update description: Put a device object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceWithConfigContext' description: '' patch: operationId: dcim_devices_partial_update description: Patch a device object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContextRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContextRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceWithConfigContext' description: '' delete: operationId: dcim_devices_destroy description: Delete a device object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this device. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/devices/{id}/render-config/: post: operationId: dcim_devices_render_config_create description: Resolve and render the preferred ConfigTemplate for this Device or Virtual Machine. parameters: - in: query name: format schema: type: string enum: - json - txt - in: path name: id schema: type: integer description: A unique integer value identifying this device. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeviceWithConfigContext' text/plain: schema: $ref: '#/components/schemas/DeviceWithConfigContext' description: '' /api/dcim/front-port-templates/: get: operationId: dcim_front_port_templates_list description: Get a list of front port template objects. parameters: - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_type_id schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: module_type_id__n schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: positions schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__empty schema: type: boolean - in: query name: positions__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rear_port_id schema: type: array items: type: integer description: Rear port (ID) explode: true style: form - in: query name: rear_port_id__n schema: type: array items: type: integer description: Rear port (ID) explode: true style: form - in: query name: type schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedFrontPortTemplateList' description: '' post: operationId: dcim_front_port_templates_create description: Post a list of front port template objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableFrontPortTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableFrontPortTemplateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableFrontPortTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableFrontPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/FrontPortTemplate' description: '' put: operationId: dcim_front_port_templates_bulk_update description: Put a list of front port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FrontPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FrontPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FrontPortTemplate' description: '' patch: operationId: dcim_front_port_templates_bulk_partial_update description: Patch a list of front port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FrontPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FrontPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FrontPortTemplate' description: '' delete: operationId: dcim_front_port_templates_bulk_destroy description: Delete a list of front port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FrontPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FrontPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/front-port-templates/{id}/: get: operationId: dcim_front_port_templates_retrieve description: Get a front port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this front port template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FrontPortTemplate' description: '' put: operationId: dcim_front_port_templates_update description: Put a front port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this front port template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableFrontPortTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableFrontPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FrontPortTemplate' description: '' patch: operationId: dcim_front_port_templates_partial_update description: Patch a front port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this front port template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableFrontPortTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableFrontPortTemplateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FrontPortTemplate' description: '' delete: operationId: dcim_front_port_templates_destroy description: Delete a front port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this front port template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/front-ports/: get: operationId: dcim_front_ports_list description: Get a list of front port objects. parameters: - in: query name: cable_connector schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__empty schema: type: boolean - in: query name: cable_connector__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_end schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__empty schema: type: boolean - in: query name: cable_end__ic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__ie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iregex schema: type: array items: type: string explode: true style: form - in: query name: cable_end__isw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__n schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__nic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__niew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nisw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__regex schema: type: array items: type: string explode: true style: form - in: query name: cable_id schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cable_id__n schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cabled schema: type: boolean - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_role schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role__n schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role_id schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_role_id__n schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_status schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__empty schema: type: boolean - in: query name: device_status__ic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__ie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iregex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__isw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__n schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__niew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nisw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__regex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_type schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type__n schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location__n schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: mark_connected schema: type: boolean - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_id schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: module_id__n schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - in: query name: occupied schema: type: boolean - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: positions schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__empty schema: type: boolean - in: query name: positions__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack__n schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rear_port_id schema: type: array items: type: integer description: Rear port (ID) explode: true style: form - in: query name: rear_port_id__n schema: type: array items: type: integer description: Rear port (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: type schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_chassis schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis__n schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis_id schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form - in: query name: virtual_chassis_id__n schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedFrontPortList' description: '' post: operationId: dcim_front_ports_create description: Post a list of front port objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableFrontPortRequest' - type: array items: $ref: '#/components/schemas/WritableFrontPortRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableFrontPortRequest' - type: array items: $ref: '#/components/schemas/WritableFrontPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/FrontPort' description: '' put: operationId: dcim_front_ports_bulk_update description: Put a list of front port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FrontPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FrontPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FrontPort' description: '' patch: operationId: dcim_front_ports_bulk_partial_update description: Patch a list of front port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FrontPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FrontPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FrontPort' description: '' delete: operationId: dcim_front_ports_bulk_destroy description: Delete a list of front port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FrontPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FrontPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/front-ports/{id}/: get: operationId: dcim_front_ports_retrieve description: Get a front port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this front port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FrontPort' description: '' put: operationId: dcim_front_ports_update description: Put a front port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this front port. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableFrontPortRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableFrontPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FrontPort' description: '' patch: operationId: dcim_front_ports_partial_update description: Patch a front port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this front port. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableFrontPortRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableFrontPortRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FrontPort' description: '' delete: operationId: dcim_front_ports_destroy description: Delete a front port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this front port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/front-ports/{id}/paths/: get: operationId: dcim_front_ports_paths_retrieve description: Return all CablePaths which traverse a given pass-through port. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this front port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FrontPort' description: '' /api/dcim/interface-templates/: get: operationId: dcim_interface_templates_list description: Get a list of interface template objects. parameters: - in: query name: bridge_id schema: type: array items: type: integer explode: true style: form - in: query name: bridge_id__n schema: type: array items: type: integer explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: enabled schema: type: boolean - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: mgmt_only schema: type: boolean - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_type_id schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: module_type_id__n schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: poe_mode schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__empty schema: type: boolean - in: query name: poe_mode__ic schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__ie schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__iew schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__iregex schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__isw schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__n schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__nic schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__nie schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__niew schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__nisw schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__regex schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_type schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__empty schema: type: boolean - in: query name: poe_type__ic schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__ie schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__iew schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__iregex schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__isw schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__n schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__nic schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__nie schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__niew schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__nisw schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__regex schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rf_role schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__empty schema: type: boolean - in: query name: rf_role__ic schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__ie schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__iew schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__iregex schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__isw schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__n schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__nic schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__nie schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__niew schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__nisw schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__regex schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: type schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInterfaceTemplateList' description: '' post: operationId: dcim_interface_templates_create description: Post a list of interface template objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableInterfaceTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableInterfaceTemplateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableInterfaceTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableInterfaceTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/InterfaceTemplate' description: '' put: operationId: dcim_interface_templates_bulk_update description: Put a list of interface template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InterfaceTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InterfaceTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InterfaceTemplate' description: '' patch: operationId: dcim_interface_templates_bulk_partial_update description: Patch a list of interface template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InterfaceTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InterfaceTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InterfaceTemplate' description: '' delete: operationId: dcim_interface_templates_bulk_destroy description: Delete a list of interface template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InterfaceTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InterfaceTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/interface-templates/{id}/: get: operationId: dcim_interface_templates_retrieve description: Get a interface template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this interface template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InterfaceTemplate' description: '' put: operationId: dcim_interface_templates_update description: Put a interface template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this interface template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableInterfaceTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableInterfaceTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InterfaceTemplate' description: '' patch: operationId: dcim_interface_templates_partial_update description: Patch a interface template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this interface template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableInterfaceTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableInterfaceTemplateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InterfaceTemplate' description: '' delete: operationId: dcim_interface_templates_destroy description: Delete a interface template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this interface template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/interfaces/: get: operationId: dcim_interfaces_list description: Get a list of interface objects. parameters: - in: query name: bridge_id schema: type: array items: type: integer description: Bridged interface (ID) explode: true style: form - in: query name: bridge_id__n schema: type: array items: type: integer description: Bridged interface (ID) explode: true style: form - in: query name: cable_connector schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__empty schema: type: boolean - in: query name: cable_connector__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_end schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__empty schema: type: boolean - in: query name: cable_end__ic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__ie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iregex schema: type: array items: type: string explode: true style: form - in: query name: cable_end__isw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__n schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__nic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__niew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nisw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__regex schema: type: array items: type: string explode: true style: form - in: query name: cable_id schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cable_id__n schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cabled schema: type: boolean - in: query name: connected schema: type: boolean - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_role schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role__n schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role_id schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_role_id__n schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_status schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__empty schema: type: boolean - in: query name: device_status__ic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__ie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iregex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__isw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__n schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__niew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nisw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__regex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_type schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type__n schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: duplex schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: duplex__empty schema: type: boolean - in: query name: duplex__ic schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: duplex__ie schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: duplex__iew schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: duplex__iregex schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: duplex__isw schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: duplex__n schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: duplex__nic schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: duplex__nie schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: duplex__niew schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: duplex__nisw schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: duplex__regex schema: type: array items: type: string x-spec-enum-id: 368458a2b67c916b nullable: true explode: true style: form - in: query name: enabled schema: type: boolean - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: kind schema: type: string description: Kind of interface - in: query name: l2vpn schema: type: array items: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true description: L2VPN explode: true style: form - in: query name: l2vpn__n schema: type: array items: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true description: L2VPN explode: true style: form - in: query name: l2vpn_id schema: type: array items: type: integer description: L2VPN (ID) explode: true style: form - in: query name: l2vpn_id__n schema: type: array items: type: integer description: L2VPN (ID) explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: lag_id schema: type: array items: type: integer description: LAG interface (ID) explode: true style: form - in: query name: lag_id__n schema: type: array items: type: integer description: LAG interface (ID) explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location__n schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: mac_address schema: type: array items: type: string explode: true style: form - in: query name: mac_address__ic schema: type: array items: type: string explode: true style: form - in: query name: mac_address__ie schema: type: array items: type: string explode: true style: form - in: query name: mac_address__iew schema: type: array items: type: string explode: true style: form - in: query name: mac_address__iregex schema: type: array items: type: string explode: true style: form - in: query name: mac_address__isw schema: type: array items: type: string explode: true style: form - in: query name: mac_address__n schema: type: array items: type: string explode: true style: form - in: query name: mac_address__nic schema: type: array items: type: string explode: true style: form - in: query name: mac_address__nie schema: type: array items: type: string explode: true style: form - in: query name: mac_address__niew schema: type: array items: type: string explode: true style: form - in: query name: mac_address__nisw schema: type: array items: type: string explode: true style: form - in: query name: mac_address__regex schema: type: array items: type: string explode: true style: form - in: query name: mark_connected schema: type: boolean - in: query name: mgmt_only schema: type: boolean - in: query name: mode schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: mode__empty schema: type: boolean description: 802.1Q Mode - in: query name: mode__ic schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: mode__ie schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: mode__iew schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: mode__iregex schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: mode__isw schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: mode__n schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: mode__nic schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: mode__nie schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: mode__niew schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: mode__nisw schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: mode__regex schema: type: array items: type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 802.1Q Mode explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_id schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: module_id__n schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: mtu schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mtu__empty schema: type: boolean - in: query name: mtu__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mtu__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mtu__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mtu__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mtu__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - in: query name: occupied schema: type: boolean - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent_id schema: type: array items: type: integer description: Parent interface (ID) explode: true style: form - in: query name: parent_id__n schema: type: array items: type: integer description: Parent interface (ID) explode: true style: form - in: query name: poe_mode schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__empty schema: type: boolean - in: query name: poe_mode__ic schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__ie schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__iew schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__iregex schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__isw schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__n schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__nic schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__nie schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__niew schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__nisw schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_mode__regex schema: type: array items: type: string x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true explode: true style: form - in: query name: poe_type schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__empty schema: type: boolean - in: query name: poe_type__ic schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__ie schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__iew schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__iregex schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__isw schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__n schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__nic schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__nie schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__niew schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__nisw schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: poe_type__regex schema: type: array items: type: string x-spec-enum-id: 5473d57885f237ab nullable: true explode: true style: form - in: query name: primary_mac_address schema: type: array items: type: string description: Primary MAC address explode: true style: form - in: query name: primary_mac_address__n schema: type: array items: type: string description: Primary MAC address explode: true style: form - in: query name: primary_mac_address_id schema: type: array items: type: integer description: Primary MAC address (ID) explode: true style: form - in: query name: primary_mac_address_id__n schema: type: array items: type: integer description: Primary MAC address (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack__n schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: rf_channel schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel__empty schema: type: boolean - in: query name: rf_channel__ic schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel__ie schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel__iew schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel__iregex schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel__isw schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel__n schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel__nic schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel__nie schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel__niew schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel__nisw schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel__regex schema: type: array items: type: string x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel explode: true style: form - in: query name: rf_channel_frequency schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_channel_frequency__empty schema: type: boolean - in: query name: rf_channel_frequency__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_channel_frequency__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_channel_frequency__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_channel_frequency__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_channel_frequency__n schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_channel_width schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_channel_width__empty schema: type: boolean - in: query name: rf_channel_width__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_channel_width__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_channel_width__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_channel_width__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_channel_width__n schema: type: array items: type: number format: double explode: true style: form - in: query name: rf_role schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__empty schema: type: boolean - in: query name: rf_role__ic schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__ie schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__iew schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__iregex schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__isw schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__n schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__nic schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__nie schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__niew schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__nisw schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: rf_role__regex schema: type: array items: type: string x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: speed schema: type: array items: type: integer format: int64 explode: true style: form - in: query name: speed__empty schema: type: array items: type: integer format: int64 explode: true style: form - in: query name: speed__gt schema: type: array items: type: integer format: int64 explode: true style: form - in: query name: speed__gte schema: type: array items: type: integer format: int64 explode: true style: form - in: query name: speed__lt schema: type: array items: type: integer format: int64 explode: true style: form - in: query name: speed__lte schema: type: array items: type: integer format: int64 explode: true style: form - in: query name: speed__n schema: type: array items: type: integer format: int64 explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tx_power schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tx_power__empty schema: type: boolean - in: query name: tx_power__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tx_power__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tx_power__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tx_power__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tx_power__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: type schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: b067eb1f050c6ae9 explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: vdc schema: type: array items: type: string description: Virtual Device Context explode: true style: form - in: query name: vdc__n schema: type: array items: type: string description: Virtual Device Context explode: true style: form - in: query name: vdc_id schema: type: array items: type: integer description: Virtual Device Context explode: true style: form - in: query name: vdc_id__n schema: type: array items: type: integer description: Virtual Device Context explode: true style: form - in: query name: vdc_identifier schema: type: array items: type: integer maximum: 32767 minimum: 0 nullable: true description: Virtual Device Context (Identifier) explode: true style: form - in: query name: vdc_identifier__n schema: type: array items: type: integer maximum: 32767 minimum: 0 nullable: true description: Virtual Device Context (Identifier) explode: true style: form - in: query name: virtual_chassis schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis__n schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis_id schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form - in: query name: virtual_chassis_id__n schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form - in: query name: virtual_chassis_member schema: type: array items: type: string explode: true style: form - in: query name: virtual_chassis_member_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: virtual_chassis_member_or_master schema: type: array items: type: string explode: true style: form - in: query name: virtual_chassis_member_or_master_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: virtual_circuit_id schema: type: array items: type: integer description: Virtual circuit (ID) explode: true style: form - in: query name: virtual_circuit_id__n schema: type: array items: type: integer description: Virtual circuit (ID) explode: true style: form - in: query name: virtual_circuit_termination_id schema: type: array items: type: integer description: Virtual circuit termination (ID) explode: true style: form - in: query name: virtual_circuit_termination_id__n schema: type: array items: type: integer description: Virtual circuit termination (ID) explode: true style: form - in: query name: vlan schema: type: string description: Assigned VID - in: query name: vlan_id schema: type: string description: Assigned VLAN - in: query name: vlan_translation_policy schema: type: array items: type: string description: VLAN Translation Policy explode: true style: form - in: query name: vlan_translation_policy__n schema: type: array items: type: string description: VLAN Translation Policy explode: true style: form - in: query name: vlan_translation_policy_id schema: type: array items: type: integer description: VLAN Translation Policy (ID) explode: true style: form - in: query name: vlan_translation_policy_id__n schema: type: array items: type: integer description: VLAN Translation Policy (ID) explode: true style: form - in: query name: vrf schema: type: array items: type: string nullable: true title: Route distinguisher description: VRF (RD) explode: true style: form - in: query name: vrf__n schema: type: array items: type: string nullable: true title: Route distinguisher description: VRF (RD) explode: true style: form - in: query name: vrf_id schema: type: array items: type: integer description: VRF explode: true style: form - in: query name: vrf_id__n schema: type: array items: type: integer description: VRF explode: true style: form - in: query name: wireless_lan_id schema: type: array items: type: integer description: Wireless LAN explode: true style: form - in: query name: wireless_lan_id__n schema: type: array items: type: integer description: Wireless LAN explode: true style: form - in: query name: wireless_link_id schema: type: array items: type: integer nullable: true description: Wireless link explode: true style: form - in: query name: wireless_link_id__n schema: type: array items: type: integer nullable: true description: Wireless link explode: true style: form - in: query name: wwn schema: type: array items: type: string explode: true style: form - in: query name: wwn__ic schema: type: array items: type: string explode: true style: form - in: query name: wwn__ie schema: type: array items: type: string explode: true style: form - in: query name: wwn__iew schema: type: array items: type: string explode: true style: form - in: query name: wwn__iregex schema: type: array items: type: string explode: true style: form - in: query name: wwn__isw schema: type: array items: type: string explode: true style: form - in: query name: wwn__n schema: type: array items: type: string explode: true style: form - in: query name: wwn__nic schema: type: array items: type: string explode: true style: form - in: query name: wwn__nie schema: type: array items: type: string explode: true style: form - in: query name: wwn__niew schema: type: array items: type: string explode: true style: form - in: query name: wwn__nisw schema: type: array items: type: string explode: true style: form - in: query name: wwn__regex schema: type: array items: type: string explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInterfaceList' description: '' post: operationId: dcim_interfaces_create description: Post a list of interface objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableInterfaceRequest' - type: array items: $ref: '#/components/schemas/WritableInterfaceRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableInterfaceRequest' - type: array items: $ref: '#/components/schemas/WritableInterfaceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Interface' description: '' put: operationId: dcim_interfaces_bulk_update description: Put a list of interface objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InterfaceRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InterfaceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Interface' description: '' patch: operationId: dcim_interfaces_bulk_partial_update description: Patch a list of interface objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InterfaceRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InterfaceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Interface' description: '' delete: operationId: dcim_interfaces_bulk_destroy description: Delete a list of interface objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InterfaceRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InterfaceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/interfaces/{id}/: get: operationId: dcim_interfaces_retrieve description: Get a interface object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this interface. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Interface' description: '' put: operationId: dcim_interfaces_update description: Put a interface object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this interface. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableInterfaceRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableInterfaceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Interface' description: '' patch: operationId: dcim_interfaces_partial_update description: Patch a interface object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this interface. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableInterfaceRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableInterfaceRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Interface' description: '' delete: operationId: dcim_interfaces_destroy description: Delete a interface object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this interface. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/interfaces/{id}/trace/: get: operationId: dcim_interfaces_trace_retrieve description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this interface. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Interface' description: '' /api/dcim/inventory-item-roles/: get: operationId: dcim_inventory_item_roles_list description: Get a list of inventory item role objects. parameters: - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventoryItemRoleList' description: '' post: operationId: dcim_inventory_item_roles_create description: Post a list of inventory item role objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/InventoryItemRoleRequest' - type: array items: $ref: '#/components/schemas/InventoryItemRoleRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/InventoryItemRoleRequest' - type: array items: $ref: '#/components/schemas/InventoryItemRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/InventoryItemRole' description: '' put: operationId: dcim_inventory_item_roles_bulk_update description: Put a list of inventory item role objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemRoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InventoryItemRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemRole' description: '' patch: operationId: dcim_inventory_item_roles_bulk_partial_update description: Patch a list of inventory item role objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemRoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InventoryItemRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemRole' description: '' delete: operationId: dcim_inventory_item_roles_bulk_destroy description: Delete a list of inventory item role objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemRoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InventoryItemRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/inventory-item-roles/{id}/: get: operationId: dcim_inventory_item_roles_retrieve description: Get a inventory item role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item role. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryItemRole' description: '' put: operationId: dcim_inventory_item_roles_update description: Put a inventory item role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item role. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/InventoryItemRoleRequest' multipart/form-data: schema: $ref: '#/components/schemas/InventoryItemRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryItemRole' description: '' patch: operationId: dcim_inventory_item_roles_partial_update description: Patch a inventory item role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item role. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedInventoryItemRoleRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedInventoryItemRoleRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryItemRole' description: '' delete: operationId: dcim_inventory_item_roles_destroy description: Delete a inventory item role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item role. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/inventory-item-templates/: get: operationId: dcim_inventory_item_templates_list description: Get a list of inventory item template objects. parameters: - in: query name: component_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__empty schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_type schema: type: array items: type: string explode: true style: form - in: query name: component_type__n schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: manufacturer schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer__n schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer_id schema: type: array items: type: integer nullable: true description: Manufacturer (ID) explode: true style: form - in: query name: manufacturer_id__n schema: type: array items: type: integer nullable: true description: Manufacturer (ID) explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: parent_id schema: type: array items: type: integer nullable: true description: Parent inventory item (ID) explode: true style: form - in: query name: parent_id__n schema: type: array items: type: integer nullable: true description: Parent inventory item (ID) explode: true style: form - in: query name: part_id schema: type: array items: type: string explode: true style: form - in: query name: part_id__empty schema: type: boolean - in: query name: part_id__ic schema: type: array items: type: string explode: true style: form - in: query name: part_id__ie schema: type: array items: type: string explode: true style: form - in: query name: part_id__iew schema: type: array items: type: string explode: true style: form - in: query name: part_id__iregex schema: type: array items: type: string explode: true style: form - in: query name: part_id__isw schema: type: array items: type: string explode: true style: form - in: query name: part_id__n schema: type: array items: type: string explode: true style: form - in: query name: part_id__nic schema: type: array items: type: string explode: true style: form - in: query name: part_id__nie schema: type: array items: type: string explode: true style: form - in: query name: part_id__niew schema: type: array items: type: string explode: true style: form - in: query name: part_id__nisw schema: type: array items: type: string explode: true style: form - in: query name: part_id__regex schema: type: array items: type: string explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: role schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role__n schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role_id schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: role_id__n schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventoryItemTemplateList' description: '' post: operationId: dcim_inventory_item_templates_create description: Post a list of inventory item template objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/InventoryItemTemplateRequest' - type: array items: $ref: '#/components/schemas/InventoryItemTemplateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/InventoryItemTemplateRequest' - type: array items: $ref: '#/components/schemas/InventoryItemTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/InventoryItemTemplate' description: '' put: operationId: dcim_inventory_item_templates_bulk_update description: Put a list of inventory item template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InventoryItemTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemTemplate' description: '' patch: operationId: dcim_inventory_item_templates_bulk_partial_update description: Patch a list of inventory item template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InventoryItemTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemTemplate' description: '' delete: operationId: dcim_inventory_item_templates_bulk_destroy description: Delete a list of inventory item template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InventoryItemTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/inventory-item-templates/{id}/: get: operationId: dcim_inventory_item_templates_retrieve description: Get a inventory item template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryItemTemplate' description: '' put: operationId: dcim_inventory_item_templates_update description: Put a inventory item template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/InventoryItemTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/InventoryItemTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryItemTemplate' description: '' patch: operationId: dcim_inventory_item_templates_partial_update description: Patch a inventory item template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedInventoryItemTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedInventoryItemTemplateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryItemTemplate' description: '' delete: operationId: dcim_inventory_item_templates_destroy description: Delete a inventory item template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/inventory-items/: get: operationId: dcim_inventory_items_list description: Get a list of inventory item objects. parameters: - in: query name: asset_tag schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__empty schema: type: boolean - in: query name: asset_tag__ic schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__ie schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__iew schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__iregex schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__isw schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__n schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nic schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nie schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__niew schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nisw schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__regex schema: type: array items: type: string explode: true style: form - in: query name: component_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__empty schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: component_type schema: type: array items: type: string explode: true style: form - in: query name: component_type__n schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_role schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role__n schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role_id schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_role_id__n schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_status schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__empty schema: type: boolean - in: query name: device_status__ic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__ie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iregex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__isw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__n schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__niew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nisw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__regex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_type schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type__n schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: discovered schema: type: boolean - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location__n schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: manufacturer schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer__n schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer_id schema: type: array items: type: integer nullable: true description: Manufacturer (ID) explode: true style: form - in: query name: manufacturer_id__n schema: type: array items: type: integer nullable: true description: Manufacturer (ID) explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent_id schema: type: array items: type: integer nullable: true description: Parent inventory item (ID) explode: true style: form - in: query name: parent_id__n schema: type: array items: type: integer nullable: true description: Parent inventory item (ID) explode: true style: form - in: query name: part_id schema: type: array items: type: string explode: true style: form - in: query name: part_id__empty schema: type: boolean - in: query name: part_id__ic schema: type: array items: type: string explode: true style: form - in: query name: part_id__ie schema: type: array items: type: string explode: true style: form - in: query name: part_id__iew schema: type: array items: type: string explode: true style: form - in: query name: part_id__iregex schema: type: array items: type: string explode: true style: form - in: query name: part_id__isw schema: type: array items: type: string explode: true style: form - in: query name: part_id__n schema: type: array items: type: string explode: true style: form - in: query name: part_id__nic schema: type: array items: type: string explode: true style: form - in: query name: part_id__nie schema: type: array items: type: string explode: true style: form - in: query name: part_id__niew schema: type: array items: type: string explode: true style: form - in: query name: part_id__nisw schema: type: array items: type: string explode: true style: form - in: query name: part_id__regex schema: type: array items: type: string explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack__n schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: role schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role__n schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role_id schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: role_id__n schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: serial schema: type: array items: type: string explode: true style: form - in: query name: serial__empty schema: type: boolean - in: query name: serial__ic schema: type: array items: type: string explode: true style: form - in: query name: serial__ie schema: type: array items: type: string explode: true style: form - in: query name: serial__iew schema: type: array items: type: string explode: true style: form - in: query name: serial__iregex schema: type: array items: type: string explode: true style: form - in: query name: serial__isw schema: type: array items: type: string explode: true style: form - in: query name: serial__n schema: type: array items: type: string explode: true style: form - in: query name: serial__nic schema: type: array items: type: string explode: true style: form - in: query name: serial__nie schema: type: array items: type: string explode: true style: form - in: query name: serial__niew schema: type: array items: type: string explode: true style: form - in: query name: serial__nisw schema: type: array items: type: string explode: true style: form - in: query name: serial__regex schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_chassis schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis__n schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis_id schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form - in: query name: virtual_chassis_id__n schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventoryItemList' description: '' post: operationId: dcim_inventory_items_create description: Post a list of inventory item objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableInventoryItemRequest' - type: array items: $ref: '#/components/schemas/WritableInventoryItemRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableInventoryItemRequest' - type: array items: $ref: '#/components/schemas/WritableInventoryItemRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/InventoryItem' description: '' put: operationId: dcim_inventory_items_bulk_update description: Put a list of inventory item objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InventoryItemRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItem' description: '' patch: operationId: dcim_inventory_items_bulk_partial_update description: Patch a list of inventory item objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InventoryItemRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItem' description: '' delete: operationId: dcim_inventory_items_bulk_destroy description: Delete a list of inventory item objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/InventoryItemRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/InventoryItemRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/inventory-items/{id}/: get: operationId: dcim_inventory_items_retrieve description: Get a inventory item object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryItem' description: '' put: operationId: dcim_inventory_items_update description: Put a inventory item object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableInventoryItemRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableInventoryItemRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryItem' description: '' patch: operationId: dcim_inventory_items_partial_update description: Patch a inventory item object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableInventoryItemRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableInventoryItemRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryItem' description: '' delete: operationId: dcim_inventory_items_destroy description: Delete a inventory item object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this inventory item. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/locations/: get: operationId: dcim_locations_list description: Get a list of location objects. parameters: - in: query name: ancestor schema: type: array items: type: string explode: true style: form - in: query name: ancestor__n schema: type: array items: type: string explode: true style: form - in: query name: ancestor_id schema: type: array items: type: string explode: true style: form - in: query name: ancestor_id__n schema: type: array items: type: string explode: true style: form - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: facility schema: type: array items: type: string explode: true style: form - in: query name: facility__empty schema: type: boolean - in: query name: facility__ic schema: type: array items: type: string explode: true style: form - in: query name: facility__ie schema: type: array items: type: string explode: true style: form - in: query name: facility__iew schema: type: array items: type: string explode: true style: form - in: query name: facility__iregex schema: type: array items: type: string explode: true style: form - in: query name: facility__isw schema: type: array items: type: string explode: true style: form - in: query name: facility__n schema: type: array items: type: string explode: true style: form - in: query name: facility__nic schema: type: array items: type: string explode: true style: form - in: query name: facility__nie schema: type: array items: type: string explode: true style: form - in: query name: facility__niew schema: type: array items: type: string explode: true style: form - in: query name: facility__nisw schema: type: array items: type: string explode: true style: form - in: query name: facility__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent schema: type: array items: type: string description: Parent location (slug) explode: true style: form - in: query name: parent__n schema: type: array items: type: string description: Parent location (slug) explode: true style: form - in: query name: parent_id schema: type: array items: type: integer nullable: true description: Parent location (ID) explode: true style: form - in: query name: parent_id__n schema: type: array items: type: integer nullable: true description: Parent location (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedLocationList' description: '' post: operationId: dcim_locations_create description: Post a list of location objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableLocationRequest' - type: array items: $ref: '#/components/schemas/WritableLocationRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableLocationRequest' - type: array items: $ref: '#/components/schemas/WritableLocationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Location' description: '' put: operationId: dcim_locations_bulk_update description: Put a list of location objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/LocationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/LocationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Location' description: '' patch: operationId: dcim_locations_bulk_partial_update description: Patch a list of location objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/LocationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/LocationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Location' description: '' delete: operationId: dcim_locations_bulk_destroy description: Delete a list of location objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/LocationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/LocationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/locations/{id}/: get: operationId: dcim_locations_retrieve description: Get a location object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this location. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Location' description: '' put: operationId: dcim_locations_update description: Put a location object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this location. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableLocationRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableLocationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Location' description: '' patch: operationId: dcim_locations_partial_update description: Patch a location object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this location. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableLocationRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableLocationRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Location' description: '' delete: operationId: dcim_locations_destroy description: Delete a location object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this location. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/mac-addresses/: get: operationId: dcim_mac_addresses_list description: Get a list of MAC address objects. parameters: - in: query name: assigned schema: type: boolean description: Is assigned - in: query name: assigned_object_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__empty schema: type: boolean - in: query name: assigned_object_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_type schema: type: array items: type: string explode: true style: form - in: query name: assigned_object_type__n schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string explode: true style: form - in: query name: device_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface schema: type: array items: type: string description: Interface (name) explode: true style: form - in: query name: interface__n schema: type: array items: type: string description: Interface (name) explode: true style: form - in: query name: interface_id schema: type: array items: type: integer description: Interface (ID) explode: true style: form - in: query name: interface_id__n schema: type: array items: type: integer description: Interface (ID) explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: mac_address schema: type: array items: type: string explode: true style: form - in: query name: mac_address__ic schema: type: array items: type: string explode: true style: form - in: query name: mac_address__ie schema: type: array items: type: string explode: true style: form - in: query name: mac_address__iew schema: type: array items: type: string explode: true style: form - in: query name: mac_address__iregex schema: type: array items: type: string explode: true style: form - in: query name: mac_address__isw schema: type: array items: type: string explode: true style: form - in: query name: mac_address__n schema: type: array items: type: string explode: true style: form - in: query name: mac_address__nic schema: type: array items: type: string explode: true style: form - in: query name: mac_address__nie schema: type: array items: type: string explode: true style: form - in: query name: mac_address__niew schema: type: array items: type: string explode: true style: form - in: query name: mac_address__nisw schema: type: array items: type: string explode: true style: form - in: query name: mac_address__regex schema: type: array items: type: string explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: primary schema: type: boolean description: Is primary - in: query name: q schema: type: string description: Search - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_machine schema: type: array items: type: string explode: true style: form - in: query name: virtual_machine_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vminterface schema: type: array items: type: string description: VM interface (name) explode: true style: form - in: query name: vminterface__n schema: type: array items: type: string description: VM interface (name) explode: true style: form - in: query name: vminterface_id schema: type: array items: type: integer description: VM interface (ID) explode: true style: form - in: query name: vminterface_id__n schema: type: array items: type: integer description: VM interface (ID) explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedMACAddressList' description: '' post: operationId: dcim_mac_addresses_create description: Post a list of MAC address objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/MACAddressRequest' - type: array items: $ref: '#/components/schemas/MACAddressRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/MACAddressRequest' - type: array items: $ref: '#/components/schemas/MACAddressRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/MACAddress' description: '' put: operationId: dcim_mac_addresses_bulk_update description: Put a list of MAC address objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MACAddressRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/MACAddressRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MACAddress' description: '' patch: operationId: dcim_mac_addresses_bulk_partial_update description: Patch a list of MAC address objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MACAddressRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/MACAddressRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/MACAddress' description: '' delete: operationId: dcim_mac_addresses_bulk_destroy description: Delete a list of MAC address objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/MACAddressRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/MACAddressRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/mac-addresses/{id}/: get: operationId: dcim_mac_addresses_retrieve description: Get a MAC address object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this MAC address. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MACAddress' description: '' put: operationId: dcim_mac_addresses_update description: Put a MAC address object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this MAC address. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/MACAddressRequest' multipart/form-data: schema: $ref: '#/components/schemas/MACAddressRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MACAddress' description: '' patch: operationId: dcim_mac_addresses_partial_update description: Patch a MAC address object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this MAC address. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedMACAddressRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedMACAddressRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MACAddress' description: '' delete: operationId: dcim_mac_addresses_destroy description: Delete a MAC address object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this MAC address. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/manufacturers/: get: operationId: dcim_manufacturers_list description: Get a list of manufacturer objects. parameters: - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedManufacturerList' description: '' post: operationId: dcim_manufacturers_create description: Post a list of manufacturer objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ManufacturerRequest' - type: array items: $ref: '#/components/schemas/ManufacturerRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/ManufacturerRequest' - type: array items: $ref: '#/components/schemas/ManufacturerRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Manufacturer' description: '' put: operationId: dcim_manufacturers_bulk_update description: Put a list of manufacturer objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ManufacturerRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ManufacturerRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Manufacturer' description: '' patch: operationId: dcim_manufacturers_bulk_partial_update description: Patch a list of manufacturer objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ManufacturerRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ManufacturerRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Manufacturer' description: '' delete: operationId: dcim_manufacturers_bulk_destroy description: Delete a list of manufacturer objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ManufacturerRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ManufacturerRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/manufacturers/{id}/: get: operationId: dcim_manufacturers_retrieve description: Get a manufacturer object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this manufacturer. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Manufacturer' description: '' put: operationId: dcim_manufacturers_update description: Put a manufacturer object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this manufacturer. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/ManufacturerRequest' multipart/form-data: schema: $ref: '#/components/schemas/ManufacturerRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Manufacturer' description: '' patch: operationId: dcim_manufacturers_partial_update description: Patch a manufacturer object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this manufacturer. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedManufacturerRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedManufacturerRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Manufacturer' description: '' delete: operationId: dcim_manufacturers_destroy description: Delete a manufacturer object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this manufacturer. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/module-bay-templates/: get: operationId: dcim_module_bay_templates_list description: Get a list of module bay template objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_type_id schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: module_type_id__n schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: position schema: type: array items: type: string explode: true style: form - in: query name: position__empty schema: type: boolean - in: query name: position__ic schema: type: array items: type: string explode: true style: form - in: query name: position__ie schema: type: array items: type: string explode: true style: form - in: query name: position__iew schema: type: array items: type: string explode: true style: form - in: query name: position__iregex schema: type: array items: type: string explode: true style: form - in: query name: position__isw schema: type: array items: type: string explode: true style: form - in: query name: position__n schema: type: array items: type: string explode: true style: form - in: query name: position__nic schema: type: array items: type: string explode: true style: form - in: query name: position__nie schema: type: array items: type: string explode: true style: form - in: query name: position__niew schema: type: array items: type: string explode: true style: form - in: query name: position__nisw schema: type: array items: type: string explode: true style: form - in: query name: position__regex schema: type: array items: type: string explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedModuleBayTemplateList' description: '' post: operationId: dcim_module_bay_templates_create description: Post a list of module bay template objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ModuleBayTemplateRequest' - type: array items: $ref: '#/components/schemas/ModuleBayTemplateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/ModuleBayTemplateRequest' - type: array items: $ref: '#/components/schemas/ModuleBayTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ModuleBayTemplate' description: '' put: operationId: dcim_module_bay_templates_bulk_update description: Put a list of module bay template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleBayTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleBayTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleBayTemplate' description: '' patch: operationId: dcim_module_bay_templates_bulk_partial_update description: Patch a list of module bay template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleBayTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleBayTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleBayTemplate' description: '' delete: operationId: dcim_module_bay_templates_bulk_destroy description: Delete a list of module bay template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleBayTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleBayTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/module-bay-templates/{id}/: get: operationId: dcim_module_bay_templates_retrieve description: Get a module bay template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module bay template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleBayTemplate' description: '' put: operationId: dcim_module_bay_templates_update description: Put a module bay template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module bay template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/ModuleBayTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ModuleBayTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleBayTemplate' description: '' patch: operationId: dcim_module_bay_templates_partial_update description: Patch a module bay template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module bay template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedModuleBayTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedModuleBayTemplateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleBayTemplate' description: '' delete: operationId: dcim_module_bay_templates_destroy description: Delete a module bay template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module bay template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/module-bays/: get: operationId: dcim_module_bays_list description: Get a list of module bay objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_role schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role__n schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role_id schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_role_id__n schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_status schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__empty schema: type: boolean - in: query name: device_status__ic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__ie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iregex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__isw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__n schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__niew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nisw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__regex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_type schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type__n schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: installed_module_id schema: type: array items: type: integer description: Installed module (ID) explode: true style: form - in: query name: installed_module_id__n schema: type: array items: type: integer description: Installed module (ID) explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location__n schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_id schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: module_id__n schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent_id schema: type: array items: type: integer nullable: true description: Parent module bay (ID) explode: true style: form - in: query name: parent_id__n schema: type: array items: type: integer nullable: true description: Parent module bay (ID) explode: true style: form - in: query name: position schema: type: array items: type: string explode: true style: form - in: query name: position__empty schema: type: boolean - in: query name: position__ic schema: type: array items: type: string explode: true style: form - in: query name: position__ie schema: type: array items: type: string explode: true style: form - in: query name: position__iew schema: type: array items: type: string explode: true style: form - in: query name: position__iregex schema: type: array items: type: string explode: true style: form - in: query name: position__isw schema: type: array items: type: string explode: true style: form - in: query name: position__n schema: type: array items: type: string explode: true style: form - in: query name: position__nic schema: type: array items: type: string explode: true style: form - in: query name: position__nie schema: type: array items: type: string explode: true style: form - in: query name: position__niew schema: type: array items: type: string explode: true style: form - in: query name: position__nisw schema: type: array items: type: string explode: true style: form - in: query name: position__regex schema: type: array items: type: string explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack__n schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_chassis schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis__n schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis_id schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form - in: query name: virtual_chassis_id__n schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedModuleBayList' description: '' post: operationId: dcim_module_bays_create description: Post a list of module bay objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ModuleBayRequest' - type: array items: $ref: '#/components/schemas/ModuleBayRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/ModuleBayRequest' - type: array items: $ref: '#/components/schemas/ModuleBayRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ModuleBay' description: '' put: operationId: dcim_module_bays_bulk_update description: Put a list of module bay objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleBayRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleBayRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleBay' description: '' patch: operationId: dcim_module_bays_bulk_partial_update description: Patch a list of module bay objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleBayRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleBayRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleBay' description: '' delete: operationId: dcim_module_bays_bulk_destroy description: Delete a list of module bay objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleBayRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleBayRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/module-bays/{id}/: get: operationId: dcim_module_bays_retrieve description: Get a module bay object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module bay. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleBay' description: '' put: operationId: dcim_module_bays_update description: Put a module bay object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module bay. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/ModuleBayRequest' multipart/form-data: schema: $ref: '#/components/schemas/ModuleBayRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleBay' description: '' patch: operationId: dcim_module_bays_partial_update description: Patch a module bay object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module bay. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedModuleBayRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedModuleBayRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleBay' description: '' delete: operationId: dcim_module_bays_destroy description: Delete a module bay object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module bay. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/module-type-profiles/: get: operationId: dcim_module_type_profiles_list description: Get a list of module type profile objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedModuleTypeProfileList' description: '' post: operationId: dcim_module_type_profiles_create description: Post a list of module type profile objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ModuleTypeProfileRequest' - type: array items: $ref: '#/components/schemas/ModuleTypeProfileRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/ModuleTypeProfileRequest' - type: array items: $ref: '#/components/schemas/ModuleTypeProfileRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ModuleTypeProfile' description: '' put: operationId: dcim_module_type_profiles_bulk_update description: Put a list of module type profile objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleTypeProfileRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleTypeProfileRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleTypeProfile' description: '' patch: operationId: dcim_module_type_profiles_bulk_partial_update description: Patch a list of module type profile objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleTypeProfileRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleTypeProfileRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleTypeProfile' description: '' delete: operationId: dcim_module_type_profiles_bulk_destroy description: Delete a list of module type profile objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleTypeProfileRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleTypeProfileRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/module-type-profiles/{id}/: get: operationId: dcim_module_type_profiles_retrieve description: Get a module type profile object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module type profile. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleTypeProfile' description: '' put: operationId: dcim_module_type_profiles_update description: Put a module type profile object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module type profile. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/ModuleTypeProfileRequest' multipart/form-data: schema: $ref: '#/components/schemas/ModuleTypeProfileRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleTypeProfile' description: '' patch: operationId: dcim_module_type_profiles_partial_update description: Patch a module type profile object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module type profile. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedModuleTypeProfileRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedModuleTypeProfileRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleTypeProfile' description: '' delete: operationId: dcim_module_type_profiles_destroy description: Delete a module type profile object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module type profile. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/module-types/: get: operationId: dcim_module_types_list description: Get a list of module type objects. parameters: - in: query name: airflow schema: type: string x-spec-enum-id: 5ad4e700c656b09d nullable: true enum: - front-to-rear - left-to-right - 'null' - passive - rear-to-front - right-to-left - side-to-rear 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' - in: query name: airflow__empty schema: type: boolean - in: query name: airflow__ic schema: type: array items: type: string explode: true style: form - in: query name: airflow__ie schema: type: array items: type: string explode: true style: form - in: query name: airflow__iew schema: type: array items: type: string explode: true style: form - in: query name: airflow__iregex schema: type: array items: type: string explode: true style: form - in: query name: airflow__isw schema: type: array items: type: string explode: true style: form - in: query name: airflow__n schema: type: string x-spec-enum-id: 5ad4e700c656b09d nullable: true enum: - front-to-rear - left-to-right - 'null' - passive - rear-to-front - right-to-left - side-to-rear 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' - in: query name: airflow__nic schema: type: array items: type: string explode: true style: form - in: query name: airflow__nie schema: type: array items: type: string explode: true style: form - in: query name: airflow__niew schema: type: array items: type: string explode: true style: form - in: query name: airflow__nisw schema: type: array items: type: string explode: true style: form - in: query name: airflow__regex schema: type: array items: type: string explode: true style: form - in: query name: console_ports schema: type: boolean description: Has console ports - in: query name: console_server_ports schema: type: boolean description: Has console server ports - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interfaces schema: type: boolean description: Has interfaces - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: manufacturer schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer__n schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer_id schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: manufacturer_id__n schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: model schema: type: array items: type: string explode: true style: form - in: query name: model__empty schema: type: boolean - in: query name: model__ic schema: type: array items: type: string explode: true style: form - in: query name: model__ie schema: type: array items: type: string explode: true style: form - in: query name: model__iew schema: type: array items: type: string explode: true style: form - in: query name: model__iregex schema: type: array items: type: string explode: true style: form - in: query name: model__isw schema: type: array items: type: string explode: true style: form - in: query name: model__n schema: type: array items: type: string explode: true style: form - in: query name: model__nic schema: type: array items: type: string explode: true style: form - in: query name: model__nie schema: type: array items: type: string explode: true style: form - in: query name: model__niew schema: type: array items: type: string explode: true style: form - in: query name: model__nisw schema: type: array items: type: string explode: true style: form - in: query name: model__regex schema: type: array items: type: string explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_count__empty schema: type: boolean - in: query name: module_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: module_count__n schema: type: array items: type: integer format: int32 explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: part_number schema: type: array items: type: string explode: true style: form - in: query name: part_number__empty schema: type: boolean - in: query name: part_number__ic schema: type: array items: type: string explode: true style: form - in: query name: part_number__ie schema: type: array items: type: string explode: true style: form - in: query name: part_number__iew schema: type: array items: type: string explode: true style: form - in: query name: part_number__iregex schema: type: array items: type: string explode: true style: form - in: query name: part_number__isw schema: type: array items: type: string explode: true style: form - in: query name: part_number__n schema: type: array items: type: string explode: true style: form - in: query name: part_number__nic schema: type: array items: type: string explode: true style: form - in: query name: part_number__nie schema: type: array items: type: string explode: true style: form - in: query name: part_number__niew schema: type: array items: type: string explode: true style: form - in: query name: part_number__nisw schema: type: array items: type: string explode: true style: form - in: query name: part_number__regex schema: type: array items: type: string explode: true style: form - in: query name: pass_through_ports schema: type: boolean description: Has pass-through ports - in: query name: power_outlets schema: type: boolean description: Has power outlets - in: query name: power_ports schema: type: boolean description: Has power ports - in: query name: profile schema: type: array items: type: string description: Profile (name) explode: true style: form - in: query name: profile__n schema: type: array items: type: string description: Profile (name) explode: true style: form - in: query name: profile_id schema: type: array items: type: integer nullable: true description: Profile (ID) explode: true style: form - in: query name: profile_id__n schema: type: array items: type: integer nullable: true description: Profile (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: weight schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__empty schema: type: boolean - in: query name: weight__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__n schema: type: array items: type: number format: double explode: true style: form - in: query name: weight_unit schema: type: string x-spec-enum-id: 2235ce3f404afbc0 nullable: true enum: - g - kg - lb - 'null' - oz description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' - in: query name: weight_unit__empty schema: type: boolean - in: query name: weight_unit__ic schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__ie schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__iew schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__iregex schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__isw schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__n schema: type: string x-spec-enum-id: 2235ce3f404afbc0 nullable: true enum: - g - kg - lb - 'null' - oz description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' - in: query name: weight_unit__nic schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__nie schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__niew schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__nisw schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__regex schema: type: array items: type: string explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedModuleTypeList' description: '' post: operationId: dcim_module_types_create description: Post a list of module type objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableModuleTypeRequest' - type: array items: $ref: '#/components/schemas/WritableModuleTypeRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableModuleTypeRequest' - type: array items: $ref: '#/components/schemas/WritableModuleTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ModuleType' description: '' put: operationId: dcim_module_types_bulk_update description: Put a list of module type objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleType' description: '' patch: operationId: dcim_module_types_bulk_partial_update description: Patch a list of module type objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleType' description: '' delete: operationId: dcim_module_types_bulk_destroy description: Delete a list of module type objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/module-types/{id}/: get: operationId: dcim_module_types_retrieve description: Get a module type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module type. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleType' description: '' put: operationId: dcim_module_types_update description: Put a module type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module type. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableModuleTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableModuleTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleType' description: '' patch: operationId: dcim_module_types_partial_update description: Patch a module type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module type. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableModuleTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableModuleTypeRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModuleType' description: '' delete: operationId: dcim_module_types_destroy description: Delete a module type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module type. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/modules/: get: operationId: dcim_modules_list description: Get a list of module objects. parameters: - in: query name: asset_tag schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__empty schema: type: boolean - in: query name: asset_tag__ic schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__ie schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__iew schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__iregex schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__isw schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__n schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nic schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nie schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__niew schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nisw schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location__n schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: manufacturer schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer__n schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer_id schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: manufacturer_id__n schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_bay_id schema: type: array items: type: string explode: true style: form - in: query name: module_bay_id__n schema: type: array items: type: string explode: true style: form - in: query name: module_type schema: type: array items: type: string description: Module type (model) explode: true style: form - in: query name: module_type__n schema: type: array items: type: string description: Module type (model) explode: true style: form - in: query name: module_type_id schema: type: array items: type: integer description: Module type (ID) explode: true style: form - in: query name: module_type_id__n schema: type: array items: type: integer description: Module type (ID) explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: profile schema: type: array items: type: string description: Profile (name) explode: true style: form - in: query name: profile__n schema: type: array items: type: string description: Profile (name) explode: true style: form - in: query name: profile_id schema: type: array items: type: integer description: Profile (ID) explode: true style: form - in: query name: profile_id__n schema: type: array items: type: integer description: Profile (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack__n schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: serial schema: type: array items: type: string explode: true style: form - in: query name: serial__empty schema: type: boolean - in: query name: serial__ic schema: type: array items: type: string explode: true style: form - in: query name: serial__ie schema: type: array items: type: string explode: true style: form - in: query name: serial__iew schema: type: array items: type: string explode: true style: form - in: query name: serial__iregex schema: type: array items: type: string explode: true style: form - in: query name: serial__isw schema: type: array items: type: string explode: true style: form - in: query name: serial__n schema: type: array items: type: string explode: true style: form - in: query name: serial__nic schema: type: array items: type: string explode: true style: form - in: query name: serial__nie schema: type: array items: type: string explode: true style: form - in: query name: serial__niew schema: type: array items: type: string explode: true style: form - in: query name: serial__nisw schema: type: array items: type: string explode: true style: form - in: query name: serial__regex schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 545817eb4c4f2ae4 explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedModuleList' description: '' post: operationId: dcim_modules_create description: Post a list of module objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableModuleRequest' - type: array items: $ref: '#/components/schemas/WritableModuleRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableModuleRequest' - type: array items: $ref: '#/components/schemas/WritableModuleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Module' description: '' put: operationId: dcim_modules_bulk_update description: Put a list of module objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Module' description: '' patch: operationId: dcim_modules_bulk_partial_update description: Patch a list of module objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Module' description: '' delete: operationId: dcim_modules_bulk_destroy description: Delete a list of module objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModuleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ModuleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/modules/{id}/: get: operationId: dcim_modules_retrieve description: Get a module object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Module' description: '' put: operationId: dcim_modules_update description: Put a module object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableModuleRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableModuleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Module' description: '' patch: operationId: dcim_modules_partial_update description: Patch a module object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableModuleRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableModuleRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Module' description: '' delete: operationId: dcim_modules_destroy description: Delete a module object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this module. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/platforms/: get: operationId: dcim_platforms_list description: Get a list of platform objects. parameters: - in: query name: ancestor schema: type: array items: type: string explode: true style: form - in: query name: ancestor__n schema: type: array items: type: string explode: true style: form - in: query name: ancestor_id schema: type: array items: type: string explode: true style: form - in: query name: ancestor_id__n schema: type: array items: type: string explode: true style: form - in: query name: available_for_device_type schema: type: string - in: query name: config_template_id schema: type: array items: type: integer nullable: true description: Config template (ID) explode: true style: form - in: query name: config_template_id__n schema: type: array items: type: integer nullable: true description: Config template (ID) explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: manufacturer schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer__n schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer_id schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: manufacturer_id__n schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent schema: type: array items: type: string description: Immediate parent platform (slug) explode: true style: form - in: query name: parent__n schema: type: array items: type: string description: Immediate parent platform (slug) explode: true style: form - in: query name: parent_id schema: type: array items: type: integer nullable: true description: Immediate parent platform (ID) explode: true style: form - in: query name: parent_id__n schema: type: array items: type: integer nullable: true description: Immediate parent platform (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPlatformList' description: '' post: operationId: dcim_platforms_create description: Post a list of platform objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritablePlatformRequest' - type: array items: $ref: '#/components/schemas/WritablePlatformRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritablePlatformRequest' - type: array items: $ref: '#/components/schemas/WritablePlatformRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Platform' description: '' put: operationId: dcim_platforms_bulk_update description: Put a list of platform objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlatformRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PlatformRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Platform' description: '' patch: operationId: dcim_platforms_bulk_partial_update description: Patch a list of platform objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlatformRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PlatformRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Platform' description: '' delete: operationId: dcim_platforms_bulk_destroy description: Delete a list of platform objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PlatformRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PlatformRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/platforms/{id}/: get: operationId: dcim_platforms_retrieve description: Get a platform object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this platform. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Platform' description: '' put: operationId: dcim_platforms_update description: Put a platform object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this platform. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePlatformRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritablePlatformRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Platform' description: '' patch: operationId: dcim_platforms_partial_update description: Patch a platform object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this platform. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePlatformRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritablePlatformRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Platform' description: '' delete: operationId: dcim_platforms_destroy description: Delete a platform object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this platform. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-feeds/: get: operationId: dcim_power_feeds_list description: Get a list of power feed objects. parameters: - in: query name: amperage schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: amperage__empty schema: type: boolean - in: query name: amperage__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: amperage__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: amperage__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: amperage__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: amperage__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: available_power schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: available_power__empty schema: type: boolean - in: query name: available_power__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: available_power__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: available_power__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: available_power__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: available_power__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__empty schema: type: boolean - in: query name: cable_connector__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_end schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__empty schema: type: boolean - in: query name: cable_end__ic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__ie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iregex schema: type: array items: type: string explode: true style: form - in: query name: cable_end__isw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__n schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__nic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__niew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nisw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__regex schema: type: array items: type: string explode: true style: form - in: query name: cable_id schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cable_id__n schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cabled schema: type: boolean - in: query name: connected schema: type: boolean - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: mark_connected schema: type: boolean - in: query name: max_utilization schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_utilization__empty schema: type: boolean - in: query name: max_utilization__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_utilization__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_utilization__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_utilization__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_utilization__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - in: query name: occupied schema: type: boolean - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: phase schema: type: string x-spec-enum-id: 994bc0696f4df57f enum: - 'null' - single-phase - three-phase description: '* `single-phase` - Single phase * `three-phase` - Three-phase' - in: query name: phase__empty schema: type: boolean - in: query name: phase__ic schema: type: array items: type: string explode: true style: form - in: query name: phase__ie schema: type: array items: type: string explode: true style: form - in: query name: phase__iew schema: type: array items: type: string explode: true style: form - in: query name: phase__iregex schema: type: array items: type: string explode: true style: form - in: query name: phase__isw schema: type: array items: type: string explode: true style: form - in: query name: phase__n schema: type: string x-spec-enum-id: 994bc0696f4df57f enum: - 'null' - single-phase - three-phase description: '* `single-phase` - Single phase * `three-phase` - Three-phase' - in: query name: phase__nic schema: type: array items: type: string explode: true style: form - in: query name: phase__nie schema: type: array items: type: string explode: true style: form - in: query name: phase__niew schema: type: array items: type: string explode: true style: form - in: query name: phase__nisw schema: type: array items: type: string explode: true style: form - in: query name: phase__regex schema: type: array items: type: string explode: true style: form - in: query name: power_panel_id schema: type: array items: type: integer description: Power panel (ID) explode: true style: form - in: query name: power_panel_id__n schema: type: array items: type: integer description: Power panel (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: ec530572dc778583 explode: true style: form - in: query name: supply schema: type: string x-spec-enum-id: 1b6d99616ca6412b enum: - ac - dc - 'null' description: '* `ac` - AC * `dc` - DC' - in: query name: supply__empty schema: type: boolean - in: query name: supply__ic schema: type: array items: type: string explode: true style: form - in: query name: supply__ie schema: type: array items: type: string explode: true style: form - in: query name: supply__iew schema: type: array items: type: string explode: true style: form - in: query name: supply__iregex schema: type: array items: type: string explode: true style: form - in: query name: supply__isw schema: type: array items: type: string explode: true style: form - in: query name: supply__n schema: type: string x-spec-enum-id: 1b6d99616ca6412b enum: - ac - dc - 'null' description: '* `ac` - AC * `dc` - DC' - in: query name: supply__nic schema: type: array items: type: string explode: true style: form - in: query name: supply__nie schema: type: array items: type: string explode: true style: form - in: query name: supply__niew schema: type: array items: type: string explode: true style: form - in: query name: supply__nisw schema: type: array items: type: string explode: true style: form - in: query name: supply__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: type schema: type: string x-spec-enum-id: 093a164236819eb8 enum: - 'null' - primary - redundant description: '* `primary` - Primary * `redundant` - Redundant' - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string explode: true style: form - in: query name: type__ie schema: type: array items: type: string explode: true style: form - in: query name: type__iew schema: type: array items: type: string explode: true style: form - in: query name: type__iregex schema: type: array items: type: string explode: true style: form - in: query name: type__isw schema: type: array items: type: string explode: true style: form - in: query name: type__n schema: type: string x-spec-enum-id: 093a164236819eb8 enum: - 'null' - primary - redundant description: '* `primary` - Primary * `redundant` - Redundant' - in: query name: type__nic schema: type: array items: type: string explode: true style: form - in: query name: type__nie schema: type: array items: type: string explode: true style: form - in: query name: type__niew schema: type: array items: type: string explode: true style: form - in: query name: type__nisw schema: type: array items: type: string explode: true style: form - in: query name: type__regex schema: type: array items: type: string explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: voltage schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: voltage__empty schema: type: boolean - in: query name: voltage__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: voltage__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: voltage__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: voltage__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: voltage__n schema: type: array items: type: integer format: int32 explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPowerFeedList' description: '' post: operationId: dcim_power_feeds_create description: Post a list of power feed objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritablePowerFeedRequest' - type: array items: $ref: '#/components/schemas/WritablePowerFeedRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritablePowerFeedRequest' - type: array items: $ref: '#/components/schemas/WritablePowerFeedRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PowerFeed' description: '' put: operationId: dcim_power_feeds_bulk_update description: Put a list of power feed objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerFeedRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerFeedRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerFeed' description: '' patch: operationId: dcim_power_feeds_bulk_partial_update description: Patch a list of power feed objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerFeedRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerFeedRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerFeed' description: '' delete: operationId: dcim_power_feeds_bulk_destroy description: Delete a list of power feed objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerFeedRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerFeedRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-feeds/{id}/: get: operationId: dcim_power_feeds_retrieve description: Get a power feed object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power feed. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerFeed' description: '' put: operationId: dcim_power_feeds_update description: Put a power feed object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power feed. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerFeedRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritablePowerFeedRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerFeed' description: '' patch: operationId: dcim_power_feeds_partial_update description: Patch a power feed object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power feed. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePowerFeedRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritablePowerFeedRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerFeed' description: '' delete: operationId: dcim_power_feeds_destroy description: Delete a power feed object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power feed. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-feeds/{id}/trace/: get: operationId: dcim_power_feeds_trace_retrieve description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power feed. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerFeed' description: '' /api/dcim/power-outlet-templates/: get: operationId: dcim_power_outlet_templates_list description: Get a list of power outlet template objects. parameters: - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: feed_leg schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__empty schema: type: boolean - in: query name: feed_leg__ic schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__ie schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__iew schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__iregex schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__isw schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__n schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__nic schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__nie schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__niew schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__nisw schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__regex schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_type_id schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: module_type_id__n schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: power_port_id schema: type: array items: type: integer nullable: true description: Power port (ID) explode: true style: form - in: query name: power_port_id__n schema: type: array items: type: integer nullable: true description: Power port (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: type schema: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true enum: - California Style - DC - IEC 60309 - IEC 60320 - IEC 60906-1 - ITA/International - Molex - NEMA (Locking) - NEMA (Non-locking) - Other - Proprietary - USB - 'null' description: '* `IEC 60320` - [(''iec-60320-c5'', ''C5''), (''iec-60320-c7'', ''C7''), (''iec-60320-c13'', ''C13''), (''iec-60320-c15'', ''C15''), (''iec-60320-c17'', ''C17''), (''iec-60320-c19'', ''C19''), (''iec-60320-c21'', ''C21'')] * `IEC 60309` - [(''iec-60309-p-n-e-4h'', ''P+N+E 4H''), (''iec-60309-p-n-e-6h'', ''P+N+E 6H''), (''iec-60309-p-n-e-9h'', ''P+N+E 9H''), (''iec-60309-2p-e-4h'', ''2P+E 4H''), (''iec-60309-2p-e-6h'', ''2P+E 6H''), (''iec-60309-2p-e-9h'', ''2P+E 9H''), (''iec-60309-3p-e-4h'', ''3P+E 4H''), (''iec-60309-3p-e-6h'', ''3P+E 6H''), (''iec-60309-3p-e-9h'', ''3P+E 9H''), (''iec-60309-3p-n-e-4h'', ''3P+N+E 4H''), (''iec-60309-3p-n-e-6h'', ''3P+N+E 6H''), (''iec-60309-3p-n-e-9h'', ''3P+N+E 9H'')] * `IEC 60906-1` - [(''iec-60906-1'', ''IEC 60906-1''), (''nbr-14136-10a'', ''2P+T 10A (NBR 14136)''), (''nbr-14136-20a'', ''2P+T 20A (NBR 14136)'')] * `NEMA (Non-locking)` - [(''nema-1-15r'', ''NEMA 1-15R''), (''nema-5-15r'', ''NEMA 5-15R''), (''nema-5-20r'', ''NEMA 5-20R''), (''nema-5-30r'', ''NEMA 5-30R''), (''nema-5-50r'', ''NEMA 5-50R''), (''nema-6-15r'', ''NEMA 6-15R''), (''nema-6-20r'', ''NEMA 6-20R''), (''nema-6-30r'', ''NEMA 6-30R''), (''nema-6-50r'', ''NEMA 6-50R''), (''nema-10-30r'', ''NEMA 10-30R''), (''nema-10-50r'', ''NEMA 10-50R''), (''nema-14-20r'', ''NEMA 14-20R''), (''nema-14-30r'', ''NEMA 14-30R''), (''nema-14-50r'', ''NEMA 14-50R''), (''nema-14-60r'', ''NEMA 14-60R''), (''nema-15-15r'', ''NEMA 15-15R''), (''nema-15-20r'', ''NEMA 15-20R''), (''nema-15-30r'', ''NEMA 15-30R''), (''nema-15-50r'', ''NEMA 15-50R''), (''nema-15-60r'', ''NEMA 15-60R'')] * `NEMA (Locking)` - [(''nema-l1-15r'', ''NEMA L1-15R''), (''nema-l5-15r'', ''NEMA L5-15R''), (''nema-l5-20r'', ''NEMA L5-20R''), (''nema-l5-30r'', ''NEMA L5-30R''), (''nema-l5-50r'', ''NEMA L5-50R''), (''nema-l6-15r'', ''NEMA L6-15R''), (''nema-l6-20r'', ''NEMA L6-20R''), (''nema-l6-30r'', ''NEMA L6-30R''), (''nema-l6-50r'', ''NEMA L6-50R''), (''nema-l10-30r'', ''NEMA L10-30R''), (''nema-l14-20r'', ''NEMA L14-20R''), (''nema-l14-30r'', ''NEMA L14-30R''), (''nema-l14-50r'', ''NEMA L14-50R''), (''nema-l14-60r'', ''NEMA L14-60R''), (''nema-l15-20r'', ''NEMA L15-20R''), (''nema-l15-30r'', ''NEMA L15-30R''), (''nema-l15-50r'', ''NEMA L15-50R''), (''nema-l15-60r'', ''NEMA L15-60R''), (''nema-l21-20r'', ''NEMA L21-20R''), (''nema-l21-30r'', ''NEMA L21-30R''), (''nema-l22-20r'', ''NEMA L22-20R''), (''nema-l22-30r'', ''NEMA L22-30R'')] * `California Style` - [(''CS6360C'', ''CS6360C''), (''CS6364C'', ''CS6364C''), (''CS8164C'', ''CS8164C''), (''CS8264C'', ''CS8264C''), (''CS8364C'', ''CS8364C''), (''CS8464C'', ''CS8464C'')] * `ITA/International` - [(''ita-e'', ''ITA Type E (CEE 7/5)''), (''ita-f'', ''ITA Type F (CEE 7/3)''), (''ita-g'', ''ITA Type G (BS 1363)''), (''ita-h'', ''ITA Type H''), (''ita-i'', ''ITA Type I''), (''ita-j'', ''ITA Type J''), (''ita-k'', ''ITA Type K''), (''ita-l'', ''ITA Type L (CEI 23-50)''), (''ita-m'', ''ITA Type M (BS 546)''), (''ita-n'', ''ITA Type N''), (''ita-o'', ''ITA Type O''), (''ita-multistandard'', ''ITA Multistandard'')] * `USB` - [(''usb-a'', ''USB Type A''), (''usb-micro-b'', ''USB Micro B''), (''usb-c'', ''USB Type C'')] * `Molex` - [(''molex-micro-fit-1x2'', ''Molex Micro-Fit 1x2''), (''molex-micro-fit-2x2'', ''Molex Micro-Fit 2x2''), (''molex-micro-fit-2x3'', ''Molex Micro-Fit 2x3''), (''molex-micro-fit-2x4'', ''Molex Micro-Fit 2x4'')] * `DC` - [(''dc-terminal'', ''DC Terminal'')] * `Proprietary` - [(''eaton-c39'', ''Eaton C39''), (''hdot-cx'', ''HDOT Cx''), (''saf-d-grid'', ''Saf-D-Grid''), (''neutrik-powercon-20a'', ''Neutrik powerCON (20A)''), (''neutrik-powercon-32a'', ''Neutrik powerCON (32A)''), (''neutrik-powercon-true1'', ''Neutrik powerCON TRUE1''), (''neutrik-powercon-true1-top'', ''Neutrik powerCON TRUE1 TOP''), (''ubiquiti-smartpower'', ''Ubiquiti SmartPower'')] * `Other` - [(''hardwired'', ''Hardwired''), (''other'', ''Other'')]' - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string explode: true style: form - in: query name: type__ie schema: type: array items: type: string explode: true style: form - in: query name: type__iew schema: type: array items: type: string explode: true style: form - in: query name: type__iregex schema: type: array items: type: string explode: true style: form - in: query name: type__isw schema: type: array items: type: string explode: true style: form - in: query name: type__n schema: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true enum: - California Style - DC - IEC 60309 - IEC 60320 - IEC 60906-1 - ITA/International - Molex - NEMA (Locking) - NEMA (Non-locking) - Other - Proprietary - USB - 'null' description: '* `IEC 60320` - [(''iec-60320-c5'', ''C5''), (''iec-60320-c7'', ''C7''), (''iec-60320-c13'', ''C13''), (''iec-60320-c15'', ''C15''), (''iec-60320-c17'', ''C17''), (''iec-60320-c19'', ''C19''), (''iec-60320-c21'', ''C21'')] * `IEC 60309` - [(''iec-60309-p-n-e-4h'', ''P+N+E 4H''), (''iec-60309-p-n-e-6h'', ''P+N+E 6H''), (''iec-60309-p-n-e-9h'', ''P+N+E 9H''), (''iec-60309-2p-e-4h'', ''2P+E 4H''), (''iec-60309-2p-e-6h'', ''2P+E 6H''), (''iec-60309-2p-e-9h'', ''2P+E 9H''), (''iec-60309-3p-e-4h'', ''3P+E 4H''), (''iec-60309-3p-e-6h'', ''3P+E 6H''), (''iec-60309-3p-e-9h'', ''3P+E 9H''), (''iec-60309-3p-n-e-4h'', ''3P+N+E 4H''), (''iec-60309-3p-n-e-6h'', ''3P+N+E 6H''), (''iec-60309-3p-n-e-9h'', ''3P+N+E 9H'')] * `IEC 60906-1` - [(''iec-60906-1'', ''IEC 60906-1''), (''nbr-14136-10a'', ''2P+T 10A (NBR 14136)''), (''nbr-14136-20a'', ''2P+T 20A (NBR 14136)'')] * `NEMA (Non-locking)` - [(''nema-1-15r'', ''NEMA 1-15R''), (''nema-5-15r'', ''NEMA 5-15R''), (''nema-5-20r'', ''NEMA 5-20R''), (''nema-5-30r'', ''NEMA 5-30R''), (''nema-5-50r'', ''NEMA 5-50R''), (''nema-6-15r'', ''NEMA 6-15R''), (''nema-6-20r'', ''NEMA 6-20R''), (''nema-6-30r'', ''NEMA 6-30R''), (''nema-6-50r'', ''NEMA 6-50R''), (''nema-10-30r'', ''NEMA 10-30R''), (''nema-10-50r'', ''NEMA 10-50R''), (''nema-14-20r'', ''NEMA 14-20R''), (''nema-14-30r'', ''NEMA 14-30R''), (''nema-14-50r'', ''NEMA 14-50R''), (''nema-14-60r'', ''NEMA 14-60R''), (''nema-15-15r'', ''NEMA 15-15R''), (''nema-15-20r'', ''NEMA 15-20R''), (''nema-15-30r'', ''NEMA 15-30R''), (''nema-15-50r'', ''NEMA 15-50R''), (''nema-15-60r'', ''NEMA 15-60R'')] * `NEMA (Locking)` - [(''nema-l1-15r'', ''NEMA L1-15R''), (''nema-l5-15r'', ''NEMA L5-15R''), (''nema-l5-20r'', ''NEMA L5-20R''), (''nema-l5-30r'', ''NEMA L5-30R''), (''nema-l5-50r'', ''NEMA L5-50R''), (''nema-l6-15r'', ''NEMA L6-15R''), (''nema-l6-20r'', ''NEMA L6-20R''), (''nema-l6-30r'', ''NEMA L6-30R''), (''nema-l6-50r'', ''NEMA L6-50R''), (''nema-l10-30r'', ''NEMA L10-30R''), (''nema-l14-20r'', ''NEMA L14-20R''), (''nema-l14-30r'', ''NEMA L14-30R''), (''nema-l14-50r'', ''NEMA L14-50R''), (''nema-l14-60r'', ''NEMA L14-60R''), (''nema-l15-20r'', ''NEMA L15-20R''), (''nema-l15-30r'', ''NEMA L15-30R''), (''nema-l15-50r'', ''NEMA L15-50R''), (''nema-l15-60r'', ''NEMA L15-60R''), (''nema-l21-20r'', ''NEMA L21-20R''), (''nema-l21-30r'', ''NEMA L21-30R''), (''nema-l22-20r'', ''NEMA L22-20R''), (''nema-l22-30r'', ''NEMA L22-30R'')] * `California Style` - [(''CS6360C'', ''CS6360C''), (''CS6364C'', ''CS6364C''), (''CS8164C'', ''CS8164C''), (''CS8264C'', ''CS8264C''), (''CS8364C'', ''CS8364C''), (''CS8464C'', ''CS8464C'')] * `ITA/International` - [(''ita-e'', ''ITA Type E (CEE 7/5)''), (''ita-f'', ''ITA Type F (CEE 7/3)''), (''ita-g'', ''ITA Type G (BS 1363)''), (''ita-h'', ''ITA Type H''), (''ita-i'', ''ITA Type I''), (''ita-j'', ''ITA Type J''), (''ita-k'', ''ITA Type K''), (''ita-l'', ''ITA Type L (CEI 23-50)''), (''ita-m'', ''ITA Type M (BS 546)''), (''ita-n'', ''ITA Type N''), (''ita-o'', ''ITA Type O''), (''ita-multistandard'', ''ITA Multistandard'')] * `USB` - [(''usb-a'', ''USB Type A''), (''usb-micro-b'', ''USB Micro B''), (''usb-c'', ''USB Type C'')] * `Molex` - [(''molex-micro-fit-1x2'', ''Molex Micro-Fit 1x2''), (''molex-micro-fit-2x2'', ''Molex Micro-Fit 2x2''), (''molex-micro-fit-2x3'', ''Molex Micro-Fit 2x3''), (''molex-micro-fit-2x4'', ''Molex Micro-Fit 2x4'')] * `DC` - [(''dc-terminal'', ''DC Terminal'')] * `Proprietary` - [(''eaton-c39'', ''Eaton C39''), (''hdot-cx'', ''HDOT Cx''), (''saf-d-grid'', ''Saf-D-Grid''), (''neutrik-powercon-20a'', ''Neutrik powerCON (20A)''), (''neutrik-powercon-32a'', ''Neutrik powerCON (32A)''), (''neutrik-powercon-true1'', ''Neutrik powerCON TRUE1''), (''neutrik-powercon-true1-top'', ''Neutrik powerCON TRUE1 TOP''), (''ubiquiti-smartpower'', ''Ubiquiti SmartPower'')] * `Other` - [(''hardwired'', ''Hardwired''), (''other'', ''Other'')]' - in: query name: type__nic schema: type: array items: type: string explode: true style: form - in: query name: type__nie schema: type: array items: type: string explode: true style: form - in: query name: type__niew schema: type: array items: type: string explode: true style: form - in: query name: type__nisw schema: type: array items: type: string explode: true style: form - in: query name: type__regex schema: type: array items: type: string explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPowerOutletTemplateList' description: '' post: operationId: dcim_power_outlet_templates_create description: Post a list of power outlet template objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' - type: array items: $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' - type: array items: $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PowerOutletTemplate' description: '' put: operationId: dcim_power_outlet_templates_bulk_update description: Put a list of power outlet template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerOutletTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerOutletTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerOutletTemplate' description: '' patch: operationId: dcim_power_outlet_templates_bulk_partial_update description: Patch a list of power outlet template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerOutletTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerOutletTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerOutletTemplate' description: '' delete: operationId: dcim_power_outlet_templates_bulk_destroy description: Delete a list of power outlet template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerOutletTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerOutletTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-outlet-templates/{id}/: get: operationId: dcim_power_outlet_templates_retrieve description: Get a power outlet template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power outlet template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerOutletTemplate' description: '' put: operationId: dcim_power_outlet_templates_update description: Put a power outlet template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power outlet template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerOutletTemplate' description: '' patch: operationId: dcim_power_outlet_templates_partial_update description: Patch a power outlet template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power outlet template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePowerOutletTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritablePowerOutletTemplateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerOutletTemplate' description: '' delete: operationId: dcim_power_outlet_templates_destroy description: Delete a power outlet template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power outlet template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-outlets/: get: operationId: dcim_power_outlets_list description: Get a list of power outlet objects. parameters: - in: query name: cable_connector schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__empty schema: type: boolean - in: query name: cable_connector__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_end schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__empty schema: type: boolean - in: query name: cable_end__ic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__ie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iregex schema: type: array items: type: string explode: true style: form - in: query name: cable_end__isw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__n schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__nic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__niew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nisw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__regex schema: type: array items: type: string explode: true style: form - in: query name: cable_id schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cable_id__n schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cabled schema: type: boolean - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: connected schema: type: boolean - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_role schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role__n schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role_id schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_role_id__n schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_status schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__empty schema: type: boolean - in: query name: device_status__ic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__ie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iregex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__isw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__n schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__niew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nisw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__regex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_type schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type__n schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: feed_leg schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__empty schema: type: boolean - in: query name: feed_leg__ic schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__ie schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__iew schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__iregex schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__isw schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__n schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__nic schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__nie schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__niew schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__nisw schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: feed_leg__regex schema: type: array items: type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: Phase (for three-phase feeds) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location__n schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: mark_connected schema: type: boolean - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_id schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: module_id__n schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - in: query name: occupied schema: type: boolean - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: power_port_id schema: type: array items: type: integer nullable: true description: Power port (ID) explode: true style: form - in: query name: power_port_id__n schema: type: array items: type: integer nullable: true description: Power port (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack__n schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: d60dce16858f3c69 explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: type schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: Physical port type explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_chassis schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis__n schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis_id schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form - in: query name: virtual_chassis_id__n schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPowerOutletList' description: '' post: operationId: dcim_power_outlets_create description: Post a list of power outlet objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritablePowerOutletRequest' - type: array items: $ref: '#/components/schemas/WritablePowerOutletRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritablePowerOutletRequest' - type: array items: $ref: '#/components/schemas/WritablePowerOutletRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PowerOutlet' description: '' put: operationId: dcim_power_outlets_bulk_update description: Put a list of power outlet objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerOutletRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerOutletRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerOutlet' description: '' patch: operationId: dcim_power_outlets_bulk_partial_update description: Patch a list of power outlet objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerOutletRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerOutletRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerOutlet' description: '' delete: operationId: dcim_power_outlets_bulk_destroy description: Delete a list of power outlet objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerOutletRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerOutletRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-outlets/{id}/: get: operationId: dcim_power_outlets_retrieve description: Get a power outlet object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power outlet. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerOutlet' description: '' put: operationId: dcim_power_outlets_update description: Put a power outlet object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power outlet. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerOutletRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritablePowerOutletRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerOutlet' description: '' patch: operationId: dcim_power_outlets_partial_update description: Patch a power outlet object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power outlet. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePowerOutletRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritablePowerOutletRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerOutlet' description: '' delete: operationId: dcim_power_outlets_destroy description: Delete a power outlet object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power outlet. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-outlets/{id}/trace/: get: operationId: dcim_power_outlets_trace_retrieve description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power outlet. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerOutlet' description: '' /api/dcim/power-panels/: get: operationId: dcim_power_panels_list description: Get a list of power panel objects. parameters: - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location_id schema: type: array items: type: string explode: true style: form - in: query name: location_id__n schema: type: array items: type: string explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPowerPanelList' description: '' post: operationId: dcim_power_panels_create description: Post a list of power panel objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/PowerPanelRequest' - type: array items: $ref: '#/components/schemas/PowerPanelRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/PowerPanelRequest' - type: array items: $ref: '#/components/schemas/PowerPanelRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PowerPanel' description: '' put: operationId: dcim_power_panels_bulk_update description: Put a list of power panel objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPanelRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerPanelRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPanel' description: '' patch: operationId: dcim_power_panels_bulk_partial_update description: Patch a list of power panel objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPanelRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerPanelRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPanel' description: '' delete: operationId: dcim_power_panels_bulk_destroy description: Delete a list of power panel objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPanelRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerPanelRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-panels/{id}/: get: operationId: dcim_power_panels_retrieve description: Get a power panel object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power panel. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerPanel' description: '' put: operationId: dcim_power_panels_update description: Put a power panel object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power panel. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PowerPanelRequest' multipart/form-data: schema: $ref: '#/components/schemas/PowerPanelRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerPanel' description: '' patch: operationId: dcim_power_panels_partial_update description: Patch a power panel object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power panel. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPowerPanelRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedPowerPanelRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerPanel' description: '' delete: operationId: dcim_power_panels_destroy description: Delete a power panel object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power panel. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-port-templates/: get: operationId: dcim_power_port_templates_list description: Get a list of power port template objects. parameters: - in: query name: allocated_draw schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: allocated_draw__empty schema: type: boolean - in: query name: allocated_draw__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: allocated_draw__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: allocated_draw__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: allocated_draw__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: allocated_draw__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: maximum_draw schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: maximum_draw__empty schema: type: boolean - in: query name: maximum_draw__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: maximum_draw__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: maximum_draw__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: maximum_draw__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: maximum_draw__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_type_id schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: module_type_id__n schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: q schema: type: string description: Search - in: query name: type schema: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true enum: - California Style - DC - IEC 60309 - IEC 60320 - IEC 60906-1 - International/ITA - Molex - NEMA (Locking) - NEMA (Non-locking) - Other - Proprietary - USB - 'null' description: '* `IEC 60320` - [(''iec-60320-c6'', ''C6''), (''iec-60320-c8'', ''C8''), (''iec-60320-c14'', ''C14''), (''iec-60320-c16'', ''C16''), (''iec-60320-c18'', ''C18''), (''iec-60320-c20'', ''C20''), (''iec-60320-c22'', ''C22'')] * `IEC 60309` - [(''iec-60309-p-n-e-4h'', ''P+N+E 4H''), (''iec-60309-p-n-e-6h'', ''P+N+E 6H''), (''iec-60309-p-n-e-9h'', ''P+N+E 9H''), (''iec-60309-2p-e-4h'', ''2P+E 4H''), (''iec-60309-2p-e-6h'', ''2P+E 6H''), (''iec-60309-2p-e-9h'', ''2P+E 9H''), (''iec-60309-3p-e-4h'', ''3P+E 4H''), (''iec-60309-3p-e-6h'', ''3P+E 6H''), (''iec-60309-3p-e-9h'', ''3P+E 9H''), (''iec-60309-3p-n-e-4h'', ''3P+N+E 4H''), (''iec-60309-3p-n-e-6h'', ''3P+N+E 6H''), (''iec-60309-3p-n-e-9h'', ''3P+N+E 9H'')] * `IEC 60906-1` - [(''iec-60906-1'', ''IEC 60906-1''), (''nbr-14136-10a'', ''2P+T 10A (NBR 14136)''), (''nbr-14136-20a'', ''2P+T 20A (NBR 14136)'')] * `NEMA (Non-locking)` - [(''nema-1-15p'', ''NEMA 1-15P''), (''nema-5-15p'', ''NEMA 5-15P''), (''nema-5-20p'', ''NEMA 5-20P''), (''nema-5-30p'', ''NEMA 5-30P''), (''nema-5-50p'', ''NEMA 5-50P''), (''nema-6-15p'', ''NEMA 6-15P''), (''nema-6-20p'', ''NEMA 6-20P''), (''nema-6-30p'', ''NEMA 6-30P''), (''nema-6-50p'', ''NEMA 6-50P''), (''nema-10-30p'', ''NEMA 10-30P''), (''nema-10-50p'', ''NEMA 10-50P''), (''nema-14-20p'', ''NEMA 14-20P''), (''nema-14-30p'', ''NEMA 14-30P''), (''nema-14-50p'', ''NEMA 14-50P''), (''nema-14-60p'', ''NEMA 14-60P''), (''nema-15-15p'', ''NEMA 15-15P''), (''nema-15-20p'', ''NEMA 15-20P''), (''nema-15-30p'', ''NEMA 15-30P''), (''nema-15-50p'', ''NEMA 15-50P''), (''nema-15-60p'', ''NEMA 15-60P'')] * `NEMA (Locking)` - [(''nema-l1-15p'', ''NEMA L1-15P''), (''nema-l5-15p'', ''NEMA L5-15P''), (''nema-l5-20p'', ''NEMA L5-20P''), (''nema-l5-30p'', ''NEMA L5-30P''), (''nema-l5-50p'', ''NEMA L5-50P''), (''nema-l6-15p'', ''NEMA L6-15P''), (''nema-l6-20p'', ''NEMA L6-20P''), (''nema-l6-30p'', ''NEMA L6-30P''), (''nema-l6-50p'', ''NEMA L6-50P''), (''nema-l10-30p'', ''NEMA L10-30P''), (''nema-l14-20p'', ''NEMA L14-20P''), (''nema-l14-30p'', ''NEMA L14-30P''), (''nema-l14-50p'', ''NEMA L14-50P''), (''nema-l14-60p'', ''NEMA L14-60P''), (''nema-l15-20p'', ''NEMA L15-20P''), (''nema-l15-30p'', ''NEMA L15-30P''), (''nema-l15-50p'', ''NEMA L15-50P''), (''nema-l15-60p'', ''NEMA L15-60P''), (''nema-l21-20p'', ''NEMA L21-20P''), (''nema-l21-30p'', ''NEMA L21-30P''), (''nema-l22-20p'', ''NEMA L22-20P''), (''nema-l22-30p'', ''NEMA L22-30P'')] * `California Style` - [(''cs6361c'', ''CS6361C''), (''cs6365c'', ''CS6365C''), (''cs8165c'', ''CS8165C''), (''cs8265c'', ''CS8265C''), (''cs8365c'', ''CS8365C''), (''cs8465c'', ''CS8465C'')] * `International/ITA` - [(''ita-c'', ''ITA Type C (CEE 7/16)''), (''ita-e'', ''ITA Type E (CEE 7/6)''), (''ita-f'', ''ITA Type F (CEE 7/4)''), (''ita-ef'', ''ITA Type E/F (CEE 7/7)''), (''ita-g'', ''ITA Type G (BS 1363)''), (''ita-h'', ''ITA Type H''), (''ita-i'', ''ITA Type I''), (''ita-j'', ''ITA Type J''), (''ita-k'', ''ITA Type K''), (''ita-l'', ''ITA Type L (CEI 23-50)''), (''ita-m'', ''ITA Type M (BS 546)''), (''ita-n'', ''ITA Type N''), (''ita-o'', ''ITA Type O'')] * `USB` - [(''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''), (''usb-3-b'', ''USB 3.0 Type B''), (''usb-3-micro-b'', ''USB 3.0 Micro B'')] * `Molex` - [(''molex-micro-fit-1x2'', ''Molex Micro-Fit 1x2''), (''molex-micro-fit-2x2'', ''Molex Micro-Fit 2x2''), (''molex-micro-fit-2x3'', ''Molex Micro-Fit 2x3''), (''molex-micro-fit-2x4'', ''Molex Micro-Fit 2x4'')] * `DC` - [(''dc-terminal'', ''DC Terminal'')] * `Proprietary` - [(''saf-d-grid'', ''Saf-D-Grid''), (''neutrik-powercon-20'', ''Neutrik powerCON (20A)''), (''neutrik-powercon-32'', ''Neutrik powerCON (32A)''), (''neutrik-powercon-true1'', ''Neutrik powerCON TRUE1''), (''neutrik-powercon-true1-top'', ''Neutrik powerCON TRUE1 TOP''), (''ubiquiti-smartpower'', ''Ubiquiti SmartPower'')] * `Other` - [(''hardwired'', ''Hardwired''), (''other'', ''Other'')]' - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string explode: true style: form - in: query name: type__ie schema: type: array items: type: string explode: true style: form - in: query name: type__iew schema: type: array items: type: string explode: true style: form - in: query name: type__iregex schema: type: array items: type: string explode: true style: form - in: query name: type__isw schema: type: array items: type: string explode: true style: form - in: query name: type__n schema: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true enum: - California Style - DC - IEC 60309 - IEC 60320 - IEC 60906-1 - International/ITA - Molex - NEMA (Locking) - NEMA (Non-locking) - Other - Proprietary - USB - 'null' description: '* `IEC 60320` - [(''iec-60320-c6'', ''C6''), (''iec-60320-c8'', ''C8''), (''iec-60320-c14'', ''C14''), (''iec-60320-c16'', ''C16''), (''iec-60320-c18'', ''C18''), (''iec-60320-c20'', ''C20''), (''iec-60320-c22'', ''C22'')] * `IEC 60309` - [(''iec-60309-p-n-e-4h'', ''P+N+E 4H''), (''iec-60309-p-n-e-6h'', ''P+N+E 6H''), (''iec-60309-p-n-e-9h'', ''P+N+E 9H''), (''iec-60309-2p-e-4h'', ''2P+E 4H''), (''iec-60309-2p-e-6h'', ''2P+E 6H''), (''iec-60309-2p-e-9h'', ''2P+E 9H''), (''iec-60309-3p-e-4h'', ''3P+E 4H''), (''iec-60309-3p-e-6h'', ''3P+E 6H''), (''iec-60309-3p-e-9h'', ''3P+E 9H''), (''iec-60309-3p-n-e-4h'', ''3P+N+E 4H''), (''iec-60309-3p-n-e-6h'', ''3P+N+E 6H''), (''iec-60309-3p-n-e-9h'', ''3P+N+E 9H'')] * `IEC 60906-1` - [(''iec-60906-1'', ''IEC 60906-1''), (''nbr-14136-10a'', ''2P+T 10A (NBR 14136)''), (''nbr-14136-20a'', ''2P+T 20A (NBR 14136)'')] * `NEMA (Non-locking)` - [(''nema-1-15p'', ''NEMA 1-15P''), (''nema-5-15p'', ''NEMA 5-15P''), (''nema-5-20p'', ''NEMA 5-20P''), (''nema-5-30p'', ''NEMA 5-30P''), (''nema-5-50p'', ''NEMA 5-50P''), (''nema-6-15p'', ''NEMA 6-15P''), (''nema-6-20p'', ''NEMA 6-20P''), (''nema-6-30p'', ''NEMA 6-30P''), (''nema-6-50p'', ''NEMA 6-50P''), (''nema-10-30p'', ''NEMA 10-30P''), (''nema-10-50p'', ''NEMA 10-50P''), (''nema-14-20p'', ''NEMA 14-20P''), (''nema-14-30p'', ''NEMA 14-30P''), (''nema-14-50p'', ''NEMA 14-50P''), (''nema-14-60p'', ''NEMA 14-60P''), (''nema-15-15p'', ''NEMA 15-15P''), (''nema-15-20p'', ''NEMA 15-20P''), (''nema-15-30p'', ''NEMA 15-30P''), (''nema-15-50p'', ''NEMA 15-50P''), (''nema-15-60p'', ''NEMA 15-60P'')] * `NEMA (Locking)` - [(''nema-l1-15p'', ''NEMA L1-15P''), (''nema-l5-15p'', ''NEMA L5-15P''), (''nema-l5-20p'', ''NEMA L5-20P''), (''nema-l5-30p'', ''NEMA L5-30P''), (''nema-l5-50p'', ''NEMA L5-50P''), (''nema-l6-15p'', ''NEMA L6-15P''), (''nema-l6-20p'', ''NEMA L6-20P''), (''nema-l6-30p'', ''NEMA L6-30P''), (''nema-l6-50p'', ''NEMA L6-50P''), (''nema-l10-30p'', ''NEMA L10-30P''), (''nema-l14-20p'', ''NEMA L14-20P''), (''nema-l14-30p'', ''NEMA L14-30P''), (''nema-l14-50p'', ''NEMA L14-50P''), (''nema-l14-60p'', ''NEMA L14-60P''), (''nema-l15-20p'', ''NEMA L15-20P''), (''nema-l15-30p'', ''NEMA L15-30P''), (''nema-l15-50p'', ''NEMA L15-50P''), (''nema-l15-60p'', ''NEMA L15-60P''), (''nema-l21-20p'', ''NEMA L21-20P''), (''nema-l21-30p'', ''NEMA L21-30P''), (''nema-l22-20p'', ''NEMA L22-20P''), (''nema-l22-30p'', ''NEMA L22-30P'')] * `California Style` - [(''cs6361c'', ''CS6361C''), (''cs6365c'', ''CS6365C''), (''cs8165c'', ''CS8165C''), (''cs8265c'', ''CS8265C''), (''cs8365c'', ''CS8365C''), (''cs8465c'', ''CS8465C'')] * `International/ITA` - [(''ita-c'', ''ITA Type C (CEE 7/16)''), (''ita-e'', ''ITA Type E (CEE 7/6)''), (''ita-f'', ''ITA Type F (CEE 7/4)''), (''ita-ef'', ''ITA Type E/F (CEE 7/7)''), (''ita-g'', ''ITA Type G (BS 1363)''), (''ita-h'', ''ITA Type H''), (''ita-i'', ''ITA Type I''), (''ita-j'', ''ITA Type J''), (''ita-k'', ''ITA Type K''), (''ita-l'', ''ITA Type L (CEI 23-50)''), (''ita-m'', ''ITA Type M (BS 546)''), (''ita-n'', ''ITA Type N''), (''ita-o'', ''ITA Type O'')] * `USB` - [(''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''), (''usb-3-b'', ''USB 3.0 Type B''), (''usb-3-micro-b'', ''USB 3.0 Micro B'')] * `Molex` - [(''molex-micro-fit-1x2'', ''Molex Micro-Fit 1x2''), (''molex-micro-fit-2x2'', ''Molex Micro-Fit 2x2''), (''molex-micro-fit-2x3'', ''Molex Micro-Fit 2x3''), (''molex-micro-fit-2x4'', ''Molex Micro-Fit 2x4'')] * `DC` - [(''dc-terminal'', ''DC Terminal'')] * `Proprietary` - [(''saf-d-grid'', ''Saf-D-Grid''), (''neutrik-powercon-20'', ''Neutrik powerCON (20A)''), (''neutrik-powercon-32'', ''Neutrik powerCON (32A)''), (''neutrik-powercon-true1'', ''Neutrik powerCON TRUE1''), (''neutrik-powercon-true1-top'', ''Neutrik powerCON TRUE1 TOP''), (''ubiquiti-smartpower'', ''Ubiquiti SmartPower'')] * `Other` - [(''hardwired'', ''Hardwired''), (''other'', ''Other'')]' - in: query name: type__nic schema: type: array items: type: string explode: true style: form - in: query name: type__nie schema: type: array items: type: string explode: true style: form - in: query name: type__niew schema: type: array items: type: string explode: true style: form - in: query name: type__nisw schema: type: array items: type: string explode: true style: form - in: query name: type__regex schema: type: array items: type: string explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPowerPortTemplateList' description: '' post: operationId: dcim_power_port_templates_create description: Post a list of power port template objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritablePowerPortTemplateRequest' - type: array items: $ref: '#/components/schemas/WritablePowerPortTemplateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritablePowerPortTemplateRequest' - type: array items: $ref: '#/components/schemas/WritablePowerPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PowerPortTemplate' description: '' put: operationId: dcim_power_port_templates_bulk_update description: Put a list of power port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPortTemplate' description: '' patch: operationId: dcim_power_port_templates_bulk_partial_update description: Patch a list of power port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPortTemplate' description: '' delete: operationId: dcim_power_port_templates_bulk_destroy description: Delete a list of power port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-port-templates/{id}/: get: operationId: dcim_power_port_templates_retrieve description: Get a power port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power port template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerPortTemplate' description: '' put: operationId: dcim_power_port_templates_update description: Put a power port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power port template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerPortTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritablePowerPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerPortTemplate' description: '' patch: operationId: dcim_power_port_templates_partial_update description: Patch a power port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power port template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePowerPortTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritablePowerPortTemplateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerPortTemplate' description: '' delete: operationId: dcim_power_port_templates_destroy description: Delete a power port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power port template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-ports/: get: operationId: dcim_power_ports_list description: Get a list of power port objects. parameters: - in: query name: allocated_draw schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: allocated_draw__empty schema: type: boolean - in: query name: allocated_draw__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: allocated_draw__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: allocated_draw__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: allocated_draw__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: allocated_draw__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__empty schema: type: boolean - in: query name: cable_connector__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_end schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__empty schema: type: boolean - in: query name: cable_end__ic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__ie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iregex schema: type: array items: type: string explode: true style: form - in: query name: cable_end__isw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__n schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__nic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__niew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nisw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__regex schema: type: array items: type: string explode: true style: form - in: query name: cable_id schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cable_id__n schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cabled schema: type: boolean - in: query name: connected schema: type: boolean - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_role schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role__n schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role_id schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_role_id__n schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_status schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__empty schema: type: boolean - in: query name: device_status__ic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__ie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iregex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__isw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__n schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__niew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nisw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__regex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_type schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type__n schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location__n schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: mark_connected schema: type: boolean - in: query name: maximum_draw schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: maximum_draw__empty schema: type: boolean - in: query name: maximum_draw__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: maximum_draw__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: maximum_draw__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: maximum_draw__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: maximum_draw__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_id schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: module_id__n schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - in: query name: occupied schema: type: boolean - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack__n schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: type schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: Physical port type explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_chassis schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis__n schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis_id schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form - in: query name: virtual_chassis_id__n schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPowerPortList' description: '' post: operationId: dcim_power_ports_create description: Post a list of power port objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritablePowerPortRequest' - type: array items: $ref: '#/components/schemas/WritablePowerPortRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritablePowerPortRequest' - type: array items: $ref: '#/components/schemas/WritablePowerPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PowerPort' description: '' put: operationId: dcim_power_ports_bulk_update description: Put a list of power port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPort' description: '' patch: operationId: dcim_power_ports_bulk_partial_update description: Patch a list of power port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPort' description: '' delete: operationId: dcim_power_ports_bulk_destroy description: Delete a list of power port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PowerPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PowerPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-ports/{id}/: get: operationId: dcim_power_ports_retrieve description: Get a power port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerPort' description: '' put: operationId: dcim_power_ports_update description: Put a power port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power port. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerPortRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritablePowerPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerPort' description: '' patch: operationId: dcim_power_ports_partial_update description: Patch a power port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power port. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePowerPortRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritablePowerPortRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerPort' description: '' delete: operationId: dcim_power_ports_destroy description: Delete a power port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/power-ports/{id}/trace/: get: operationId: dcim_power_ports_trace_retrieve description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this power port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerPort' description: '' /api/dcim/rack-reservations/: get: operationId: dcim_rack_reservations_list description: Get a list of rack reservation objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string explode: true style: form - in: query name: location__n schema: type: array items: type: string explode: true style: form - in: query name: location_id schema: type: array items: type: string explode: true style: form - in: query name: location_id__n schema: type: array items: type: string explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: ed6038a4deee151c explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: unit schema: type: number - in: query name: unit__empty schema: type: number - in: query name: unit__gt schema: type: number - in: query name: unit__gte schema: type: number - in: query name: unit__lt schema: type: number - in: query name: unit__lte schema: type: number - in: query name: unit__n schema: type: number - in: query name: updated_by_request schema: type: string format: uuid - in: query name: user schema: type: array items: type: string description: User (name) explode: true style: form - in: query name: user__n schema: type: array items: type: string description: User (name) explode: true style: form - in: query name: user_id schema: type: array items: type: integer description: User (ID) explode: true style: form - in: query name: user_id__n schema: type: array items: type: integer description: User (ID) explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRackReservationList' description: '' post: operationId: dcim_rack_reservations_create description: Post a list of rack reservation objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableRackReservationRequest' - type: array items: $ref: '#/components/schemas/WritableRackReservationRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableRackReservationRequest' - type: array items: $ref: '#/components/schemas/WritableRackReservationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RackReservation' description: '' put: operationId: dcim_rack_reservations_bulk_update description: Put a list of rack reservation objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackReservationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackReservationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RackReservation' description: '' patch: operationId: dcim_rack_reservations_bulk_partial_update description: Patch a list of rack reservation objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackReservationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackReservationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RackReservation' description: '' delete: operationId: dcim_rack_reservations_bulk_destroy description: Delete a list of rack reservation objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackReservationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackReservationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/rack-reservations/{id}/: get: operationId: dcim_rack_reservations_retrieve description: Get a rack reservation object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack reservation. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RackReservation' description: '' put: operationId: dcim_rack_reservations_update description: Put a rack reservation object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack reservation. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRackReservationRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableRackReservationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RackReservation' description: '' patch: operationId: dcim_rack_reservations_partial_update description: Patch a rack reservation object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack reservation. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRackReservationRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableRackReservationRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RackReservation' description: '' delete: operationId: dcim_rack_reservations_destroy description: Delete a rack reservation object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack reservation. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/rack-roles/: get: operationId: dcim_rack_roles_list description: Get a list of rack role objects. parameters: - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRackRoleList' description: '' post: operationId: dcim_rack_roles_create description: Post a list of rack role objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/RackRoleRequest' - type: array items: $ref: '#/components/schemas/RackRoleRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/RackRoleRequest' - type: array items: $ref: '#/components/schemas/RackRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RackRole' description: '' put: operationId: dcim_rack_roles_bulk_update description: Put a list of rack role objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackRoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RackRole' description: '' patch: operationId: dcim_rack_roles_bulk_partial_update description: Patch a list of rack role objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackRoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RackRole' description: '' delete: operationId: dcim_rack_roles_bulk_destroy description: Delete a list of rack role objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackRoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/rack-roles/{id}/: get: operationId: dcim_rack_roles_retrieve description: Get a rack role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack role. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RackRole' description: '' put: operationId: dcim_rack_roles_update description: Put a rack role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack role. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/RackRoleRequest' multipart/form-data: schema: $ref: '#/components/schemas/RackRoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RackRole' description: '' patch: operationId: dcim_rack_roles_partial_update description: Patch a rack role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack role. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRackRoleRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedRackRoleRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RackRole' description: '' delete: operationId: dcim_rack_roles_destroy description: Delete a rack role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack role. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/rack-types/: get: operationId: dcim_rack_types_list description: Get a list of rack type objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: desc_units schema: type: boolean - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: form_factor schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: form_factor__empty schema: type: boolean - in: query name: form_factor__ic schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: form_factor__ie schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: form_factor__iew schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: form_factor__iregex schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: form_factor__isw schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: form_factor__n schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: form_factor__nic schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: form_factor__nie schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: form_factor__niew schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: form_factor__nisw schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: form_factor__regex schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: manufacturer schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer__n schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer_id schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: manufacturer_id__n schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: max_weight schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_weight__empty schema: type: boolean - in: query name: max_weight__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_weight__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_weight__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_weight__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_weight__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: model schema: type: array items: type: string explode: true style: form - in: query name: model__empty schema: type: boolean - in: query name: model__ic schema: type: array items: type: string explode: true style: form - in: query name: model__ie schema: type: array items: type: string explode: true style: form - in: query name: model__iew schema: type: array items: type: string explode: true style: form - in: query name: model__iregex schema: type: array items: type: string explode: true style: form - in: query name: model__isw schema: type: array items: type: string explode: true style: form - in: query name: model__n schema: type: array items: type: string explode: true style: form - in: query name: model__nic schema: type: array items: type: string explode: true style: form - in: query name: model__nie schema: type: array items: type: string explode: true style: form - in: query name: model__niew schema: type: array items: type: string explode: true style: form - in: query name: model__nisw schema: type: array items: type: string explode: true style: form - in: query name: model__regex schema: type: array items: type: string explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: mounting_depth schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mounting_depth__empty schema: type: boolean - in: query name: mounting_depth__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mounting_depth__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mounting_depth__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mounting_depth__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mounting_depth__n schema: type: array items: type: integer format: int32 explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: outer_depth schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_depth__empty schema: type: boolean - in: query name: outer_depth__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_depth__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_depth__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_depth__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_depth__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height__empty schema: type: boolean - in: query name: outer_height__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_unit schema: type: string x-spec-enum-id: 3d701848b66312c3 nullable: true enum: - in - mm - 'null' description: '* `mm` - Millimeters * `in` - Inches' - in: query name: outer_unit__empty schema: type: boolean - in: query name: outer_unit__ic schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__ie schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__iew schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__iregex schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__isw schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__n schema: type: string x-spec-enum-id: 3d701848b66312c3 nullable: true enum: - in - mm - 'null' description: '* `mm` - Millimeters * `in` - Inches' - in: query name: outer_unit__nic schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__nie schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__niew schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__nisw schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__regex schema: type: array items: type: string explode: true style: form - in: query name: outer_width schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_width__empty schema: type: boolean - in: query name: outer_width__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_width__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_width__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_width__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_width__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rack_count__empty schema: type: boolean - in: query name: rack_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rack_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rack_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rack_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: rack_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: starting_unit schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: starting_unit__empty schema: type: boolean - in: query name: starting_unit__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: starting_unit__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: starting_unit__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: starting_unit__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: starting_unit__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: u_height schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: u_height__empty schema: type: boolean - in: query name: u_height__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: u_height__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: u_height__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: u_height__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: u_height__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: weight schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__empty schema: type: boolean - in: query name: weight__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__n schema: type: array items: type: number format: double explode: true style: form - in: query name: weight_unit schema: type: string x-spec-enum-id: 2235ce3f404afbc0 nullable: true enum: - g - kg - lb - 'null' - oz description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' - in: query name: weight_unit__empty schema: type: boolean - in: query name: weight_unit__ic schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__ie schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__iew schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__iregex schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__isw schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__n schema: type: string x-spec-enum-id: 2235ce3f404afbc0 nullable: true enum: - g - kg - lb - 'null' - oz description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' - in: query name: weight_unit__nic schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__nie schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__niew schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__nisw schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__regex schema: type: array items: type: string explode: true style: form - in: query name: width schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__ic schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__ie schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__iew schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__iregex schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__isw schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__n schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__nic schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__nie schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__niew schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__nisw schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__regex schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRackTypeList' description: '' post: operationId: dcim_rack_types_create description: Post a list of rack type objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableRackTypeRequest' - type: array items: $ref: '#/components/schemas/WritableRackTypeRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableRackTypeRequest' - type: array items: $ref: '#/components/schemas/WritableRackTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RackType' description: '' put: operationId: dcim_rack_types_bulk_update description: Put a list of rack type objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RackType' description: '' patch: operationId: dcim_rack_types_bulk_partial_update description: Patch a list of rack type objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RackType' description: '' delete: operationId: dcim_rack_types_bulk_destroy description: Delete a list of rack type objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/rack-types/{id}/: get: operationId: dcim_rack_types_retrieve description: Get a rack type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack type. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RackType' description: '' put: operationId: dcim_rack_types_update description: Put a rack type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack type. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRackTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableRackTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RackType' description: '' patch: operationId: dcim_rack_types_partial_update description: Patch a rack type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack type. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRackTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableRackTypeRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RackType' description: '' delete: operationId: dcim_rack_types_destroy description: Delete a rack type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack type. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/racks/: get: operationId: dcim_racks_list description: Get a list of rack objects. parameters: - in: query name: airflow schema: type: string x-spec-enum-id: a784734d07ef1b3c nullable: true enum: - front-to-rear - 'null' - rear-to-front description: '* `front-to-rear` - Front to rear * `rear-to-front` - Rear to front' - in: query name: airflow__empty schema: type: boolean - in: query name: airflow__ic schema: type: array items: type: string explode: true style: form - in: query name: airflow__ie schema: type: array items: type: string explode: true style: form - in: query name: airflow__iew schema: type: array items: type: string explode: true style: form - in: query name: airflow__iregex schema: type: array items: type: string explode: true style: form - in: query name: airflow__isw schema: type: array items: type: string explode: true style: form - in: query name: airflow__n schema: type: string x-spec-enum-id: a784734d07ef1b3c nullable: true enum: - front-to-rear - 'null' - rear-to-front description: '* `front-to-rear` - Front to rear * `rear-to-front` - Rear to front' - in: query name: airflow__nic schema: type: array items: type: string explode: true style: form - in: query name: airflow__nie schema: type: array items: type: string explode: true style: form - in: query name: airflow__niew schema: type: array items: type: string explode: true style: form - in: query name: airflow__nisw schema: type: array items: type: string explode: true style: form - in: query name: airflow__regex schema: type: array items: type: string explode: true style: form - in: query name: asset_tag schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__empty schema: type: boolean - in: query name: asset_tag__ic schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__ie schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__iew schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__iregex schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__isw schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__n schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nic schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nie schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__niew schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__nisw schema: type: array items: type: string explode: true style: form - in: query name: asset_tag__regex schema: type: array items: type: string explode: true style: form - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: desc_units schema: type: boolean - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: facility_id schema: type: array items: type: string explode: true style: form - in: query name: facility_id__empty schema: type: boolean - in: query name: facility_id__ic schema: type: array items: type: string explode: true style: form - in: query name: facility_id__ie schema: type: array items: type: string explode: true style: form - in: query name: facility_id__iew schema: type: array items: type: string explode: true style: form - in: query name: facility_id__iregex schema: type: array items: type: string explode: true style: form - in: query name: facility_id__isw schema: type: array items: type: string explode: true style: form - in: query name: facility_id__n schema: type: array items: type: string explode: true style: form - in: query name: facility_id__nic schema: type: array items: type: string explode: true style: form - in: query name: facility_id__nie schema: type: array items: type: string explode: true style: form - in: query name: facility_id__niew schema: type: array items: type: string explode: true style: form - in: query name: facility_id__nisw schema: type: array items: type: string explode: true style: form - in: query name: facility_id__regex schema: type: array items: type: string explode: true style: form - in: query name: form_factor schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: form_factor__empty schema: type: boolean - in: query name: form_factor__ic schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: form_factor__ie schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: form_factor__iew schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: form_factor__iregex schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: form_factor__isw schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: form_factor__n schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: form_factor__nic schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: form_factor__nie schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: form_factor__niew schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: form_factor__nisw schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: form_factor__regex schema: type: array items: type: string x-spec-enum-id: 8a902fde21d48841 nullable: true explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string explode: true style: form - in: query name: location__n schema: type: array items: type: string explode: true style: form - in: query name: location_id schema: type: array items: type: string explode: true style: form - in: query name: location_id__n schema: type: array items: type: string explode: true style: form - in: query name: manufacturer schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer__n schema: type: array items: type: string description: Manufacturer (slug) explode: true style: form - in: query name: manufacturer_id schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: manufacturer_id__n schema: type: array items: type: integer description: Manufacturer (ID) explode: true style: form - in: query name: max_weight schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_weight__empty schema: type: boolean - in: query name: max_weight__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_weight__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_weight__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_weight__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: max_weight__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: mounting_depth schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mounting_depth__empty schema: type: boolean - in: query name: mounting_depth__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mounting_depth__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mounting_depth__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mounting_depth__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mounting_depth__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: outer_depth schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_depth__empty schema: type: boolean - in: query name: outer_depth__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_depth__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_depth__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_depth__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_depth__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height__empty schema: type: boolean - in: query name: outer_height__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_height__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_unit schema: type: string x-spec-enum-id: 3d701848b66312c3 nullable: true enum: - in - mm - 'null' description: '* `mm` - Millimeters * `in` - Inches' - in: query name: outer_unit__empty schema: type: boolean - in: query name: outer_unit__ic schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__ie schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__iew schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__iregex schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__isw schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__n schema: type: string x-spec-enum-id: 3d701848b66312c3 nullable: true enum: - in - mm - 'null' description: '* `mm` - Millimeters * `in` - Inches' - in: query name: outer_unit__nic schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__nie schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__niew schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__nisw schema: type: array items: type: string explode: true style: form - in: query name: outer_unit__regex schema: type: array items: type: string explode: true style: form - in: query name: outer_width schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_width__empty schema: type: boolean - in: query name: outer_width__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_width__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_width__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_width__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: outer_width__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack_type schema: type: array items: type: string description: Rack type (slug) explode: true style: form - in: query name: rack_type__n schema: type: array items: type: string description: Rack type (slug) explode: true style: form - in: query name: rack_type_id schema: type: array items: type: integer nullable: true description: Rack type (ID) explode: true style: form - in: query name: rack_type_id__n schema: type: array items: type: integer nullable: true description: Rack type (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: role schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role__n schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role_id schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: role_id__n schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: serial schema: type: array items: type: string explode: true style: form - in: query name: serial__empty schema: type: boolean - in: query name: serial__ic schema: type: array items: type: string explode: true style: form - in: query name: serial__ie schema: type: array items: type: string explode: true style: form - in: query name: serial__iew schema: type: array items: type: string explode: true style: form - in: query name: serial__iregex schema: type: array items: type: string explode: true style: form - in: query name: serial__isw schema: type: array items: type: string explode: true style: form - in: query name: serial__n schema: type: array items: type: string explode: true style: form - in: query name: serial__nic schema: type: array items: type: string explode: true style: form - in: query name: serial__nie schema: type: array items: type: string explode: true style: form - in: query name: serial__niew schema: type: array items: type: string explode: true style: form - in: query name: serial__nisw schema: type: array items: type: string explode: true style: form - in: query name: serial__regex schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: starting_unit schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: starting_unit__empty schema: type: boolean - in: query name: starting_unit__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: starting_unit__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: starting_unit__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: starting_unit__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: starting_unit__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 76eea4eef8804bcb explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: u_height schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: u_height__empty schema: type: boolean - in: query name: u_height__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: u_height__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: u_height__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: u_height__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: u_height__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: weight schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__empty schema: type: boolean - in: query name: weight__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: weight__n schema: type: array items: type: number format: double explode: true style: form - in: query name: weight_unit schema: type: string x-spec-enum-id: 2235ce3f404afbc0 nullable: true enum: - g - kg - lb - 'null' - oz description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' - in: query name: weight_unit__empty schema: type: boolean - in: query name: weight_unit__ic schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__ie schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__iew schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__iregex schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__isw schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__n schema: type: string x-spec-enum-id: 2235ce3f404afbc0 nullable: true enum: - g - kg - lb - 'null' - oz description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' - in: query name: weight_unit__nic schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__nie schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__niew schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__nisw schema: type: array items: type: string explode: true style: form - in: query name: weight_unit__regex schema: type: array items: type: string explode: true style: form - in: query name: width schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__ic schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__ie schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__iew schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__iregex schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__isw schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__n schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__nic schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__nie schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__niew schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__nisw schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form - in: query name: width__regex schema: type: array items: type: integer x-spec-enum-id: 9b322795f297a9c3 description: Rail-to-rail width explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRackList' description: '' post: operationId: dcim_racks_create description: Post a list of rack objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableRackRequest' - type: array items: $ref: '#/components/schemas/WritableRackRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableRackRequest' - type: array items: $ref: '#/components/schemas/WritableRackRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Rack' description: '' put: operationId: dcim_racks_bulk_update description: Put a list of rack objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Rack' description: '' patch: operationId: dcim_racks_bulk_partial_update description: Patch a list of rack objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Rack' description: '' delete: operationId: dcim_racks_bulk_destroy description: Delete a list of rack objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RackRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RackRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/racks/{id}/: get: operationId: dcim_racks_retrieve description: Get a rack object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Rack' description: '' put: operationId: dcim_racks_update description: Put a rack object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRackRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableRackRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Rack' description: '' patch: operationId: dcim_racks_partial_update description: Patch a rack object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRackRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableRackRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Rack' description: '' delete: operationId: dcim_racks_destroy description: Delete a rack object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rack. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/racks/{id}/elevation/: get: operationId: dcim_racks_elevation_retrieve description: Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG. parameters: - in: query name: exclude schema: type: integer - in: query name: expand_devices schema: type: boolean default: true - in: query name: face schema: enum: - front - rear type: string x-spec-enum-id: d2fb9b3f75158b83 default: front minLength: 1 description: '* `front` - Front * `rear` - Rear' - in: path name: id schema: type: integer description: A unique integer value identifying this rack. required: true - in: query name: include_images schema: type: boolean default: true - in: query name: legend_width schema: type: integer default: 30 - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: margin_width schema: type: integer default: 15 - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: q schema: type: string minLength: 1 - in: query name: render schema: enum: - json - svg type: string x-spec-enum-id: 09901a5ff13ba07a default: json minLength: 1 description: '* `json` - json * `svg` - svg' - in: query name: unit_height schema: type: integer - in: query name: unit_width schema: type: integer tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRackUnitList' description: '' /api/dcim/rear-port-templates/: get: operationId: dcim_rear_port_templates_list description: Get a list of rear port template objects. parameters: - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer nullable: true description: Device type (ID) explode: true style: form - in: query name: front_port_id schema: type: array items: type: integer description: Front port (ID) explode: true style: form - in: query name: front_port_id__n schema: type: array items: type: integer description: Front port (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_type_id schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: module_type_id__n schema: type: array items: type: integer nullable: true description: Module type (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: positions schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__empty schema: type: boolean - in: query name: positions__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: type schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRearPortTemplateList' description: '' post: operationId: dcim_rear_port_templates_create description: Post a list of rear port template objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableRearPortTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableRearPortTemplateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableRearPortTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableRearPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RearPortTemplate' description: '' put: operationId: dcim_rear_port_templates_bulk_update description: Put a list of rear port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RearPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RearPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RearPortTemplate' description: '' patch: operationId: dcim_rear_port_templates_bulk_partial_update description: Patch a list of rear port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RearPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RearPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RearPortTemplate' description: '' delete: operationId: dcim_rear_port_templates_bulk_destroy description: Delete a list of rear port template objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RearPortTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RearPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/rear-port-templates/{id}/: get: operationId: dcim_rear_port_templates_retrieve description: Get a rear port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rear port template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RearPortTemplate' description: '' put: operationId: dcim_rear_port_templates_update description: Put a rear port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rear port template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRearPortTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableRearPortTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RearPortTemplate' description: '' patch: operationId: dcim_rear_port_templates_partial_update description: Patch a rear port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rear port template. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRearPortTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableRearPortTemplateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RearPortTemplate' description: '' delete: operationId: dcim_rear_port_templates_destroy description: Delete a rear port template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rear port template. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/rear-ports/: get: operationId: dcim_rear_ports_list description: Get a list of rear port objects. parameters: - in: query name: cable_connector schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__empty schema: type: boolean - in: query name: cable_connector__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_end schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__empty schema: type: boolean - in: query name: cable_end__ic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__ie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iregex schema: type: array items: type: string explode: true style: form - in: query name: cable_end__isw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__n schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__nic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__niew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nisw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__regex schema: type: array items: type: string explode: true style: form - in: query name: cable_id schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cable_id__n schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cabled schema: type: boolean - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_role schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role__n schema: type: array items: type: string description: Device role (slug) explode: true style: form - in: query name: device_role_id schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_role_id__n schema: type: array items: type: integer description: Device role (ID) explode: true style: form - in: query name: device_status schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__empty schema: type: boolean - in: query name: device_status__ic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__ie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__iregex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__isw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__n schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nic schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nie schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__niew schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__nisw schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_status__regex schema: type: array items: type: string x-spec-enum-id: 65feb4244cc9110c explode: true style: form - in: query name: device_type schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type__n schema: type: array items: type: string description: Device type (model) explode: true style: form - in: query name: device_type_id schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: device_type_id__n schema: type: array items: type: integer description: Device type (ID) explode: true style: form - in: query name: front_port_id schema: type: array items: type: integer description: Front port (ID) explode: true style: form - in: query name: front_port_id__n schema: type: array items: type: integer description: Front port (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: label schema: type: array items: type: string explode: true style: form - in: query name: label__empty schema: type: boolean - in: query name: label__ic schema: type: array items: type: string explode: true style: form - in: query name: label__ie schema: type: array items: type: string explode: true style: form - in: query name: label__iew schema: type: array items: type: string explode: true style: form - in: query name: label__iregex schema: type: array items: type: string explode: true style: form - in: query name: label__isw schema: type: array items: type: string explode: true style: form - in: query name: label__n schema: type: array items: type: string explode: true style: form - in: query name: label__nic schema: type: array items: type: string explode: true style: form - in: query name: label__nie schema: type: array items: type: string explode: true style: form - in: query name: label__niew schema: type: array items: type: string explode: true style: form - in: query name: label__nisw schema: type: array items: type: string explode: true style: form - in: query name: label__regex schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location__n schema: type: array items: type: string description: Location (slug) explode: true style: form - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: mark_connected schema: type: boolean - in: query name: modified_by_request schema: type: string format: uuid - in: query name: module_id schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: module_id__n schema: type: array items: type: integer nullable: true description: Module (ID) explode: true style: form - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - in: query name: occupied schema: type: boolean - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: positions schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__empty schema: type: boolean - in: query name: positions__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: positions__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack__n schema: type: array items: type: string description: Rack (name) explode: true style: form - in: query name: rack_id schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: rack_id__n schema: type: array items: type: integer description: Rack (ID) explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: type schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: 2696b7065f33307c explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_chassis schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis__n schema: type: array items: type: string description: Virtual Chassis explode: true style: form - in: query name: virtual_chassis_id schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form - in: query name: virtual_chassis_id__n schema: type: array items: type: integer description: Virtual Chassis (ID) explode: true style: form tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRearPortList' description: '' post: operationId: dcim_rear_ports_create description: Post a list of rear port objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableRearPortRequest' - type: array items: $ref: '#/components/schemas/WritableRearPortRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableRearPortRequest' - type: array items: $ref: '#/components/schemas/WritableRearPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RearPort' description: '' put: operationId: dcim_rear_ports_bulk_update description: Put a list of rear port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RearPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RearPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RearPort' description: '' patch: operationId: dcim_rear_ports_bulk_partial_update description: Patch a list of rear port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RearPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RearPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RearPort' description: '' delete: operationId: dcim_rear_ports_bulk_destroy description: Delete a list of rear port objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RearPortRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RearPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/rear-ports/{id}/: get: operationId: dcim_rear_ports_retrieve description: Get a rear port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rear port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RearPort' description: '' put: operationId: dcim_rear_ports_update description: Put a rear port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rear port. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRearPortRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableRearPortRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RearPort' description: '' patch: operationId: dcim_rear_ports_partial_update description: Patch a rear port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rear port. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRearPortRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableRearPortRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RearPort' description: '' delete: operationId: dcim_rear_ports_destroy description: Delete a rear port object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rear port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/rear-ports/{id}/paths/: get: operationId: dcim_rear_ports_paths_retrieve description: Return all CablePaths which traverse a given pass-through port. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this rear port. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RearPort' description: '' /api/dcim/regions/: get: operationId: dcim_regions_list description: Get a list of region objects. parameters: - in: query name: ancestor schema: type: array items: type: string explode: true style: form - in: query name: ancestor__n schema: type: array items: type: string explode: true style: form - in: query name: ancestor_id schema: type: array items: type: string explode: true style: form - in: query name: ancestor_id__n schema: type: array items: type: string explode: true style: form - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent schema: type: array items: type: string description: Parent region (slug) explode: true style: form - in: query name: parent__n schema: type: array items: type: string description: Parent region (slug) explode: true style: form - in: query name: parent_id schema: type: array items: type: integer nullable: true description: Parent region (ID) explode: true style: form - in: query name: parent_id__n schema: type: array items: type: integer nullable: true description: Parent region (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRegionList' description: '' post: operationId: dcim_regions_create description: Post a list of region objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableRegionRequest' - type: array items: $ref: '#/components/schemas/WritableRegionRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableRegionRequest' - type: array items: $ref: '#/components/schemas/WritableRegionRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Region' description: '' put: operationId: dcim_regions_bulk_update description: Put a list of region objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RegionRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RegionRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Region' description: '' patch: operationId: dcim_regions_bulk_partial_update description: Patch a list of region objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RegionRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RegionRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Region' description: '' delete: operationId: dcim_regions_bulk_destroy description: Delete a list of region objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RegionRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RegionRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/regions/{id}/: get: operationId: dcim_regions_retrieve description: Get a region object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this region. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Region' description: '' put: operationId: dcim_regions_update description: Put a region object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this region. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRegionRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableRegionRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Region' description: '' patch: operationId: dcim_regions_partial_update description: Patch a region object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this region. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRegionRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableRegionRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Region' description: '' delete: operationId: dcim_regions_destroy description: Delete a region object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this region. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/site-groups/: get: operationId: dcim_site_groups_list description: Get a list of site group objects. parameters: - in: query name: ancestor schema: type: array items: type: string explode: true style: form - in: query name: ancestor__n schema: type: array items: type: string explode: true style: form - in: query name: ancestor_id schema: type: array items: type: string explode: true style: form - in: query name: ancestor_id__n schema: type: array items: type: string explode: true style: form - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent schema: type: array items: type: string description: Parent site group (slug) explode: true style: form - in: query name: parent__n schema: type: array items: type: string description: Parent site group (slug) explode: true style: form - in: query name: parent_id schema: type: array items: type: integer nullable: true description: Parent site group (ID) explode: true style: form - in: query name: parent_id__n schema: type: array items: type: integer nullable: true description: Parent site group (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSiteGroupList' description: '' post: operationId: dcim_site_groups_create description: Post a list of site group objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableSiteGroupRequest' - type: array items: $ref: '#/components/schemas/WritableSiteGroupRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableSiteGroupRequest' - type: array items: $ref: '#/components/schemas/WritableSiteGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/SiteGroup' description: '' put: operationId: dcim_site_groups_bulk_update description: Put a list of site group objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SiteGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/SiteGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SiteGroup' description: '' patch: operationId: dcim_site_groups_bulk_partial_update description: Patch a list of site group objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SiteGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/SiteGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SiteGroup' description: '' delete: operationId: dcim_site_groups_bulk_destroy description: Delete a list of site group objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SiteGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/SiteGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/site-groups/{id}/: get: operationId: dcim_site_groups_retrieve description: Get a site group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this site group. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SiteGroup' description: '' put: operationId: dcim_site_groups_update description: Put a site group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this site group. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableSiteGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableSiteGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SiteGroup' description: '' patch: operationId: dcim_site_groups_partial_update description: Patch a site group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this site group. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableSiteGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableSiteGroupRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SiteGroup' description: '' delete: operationId: dcim_site_groups_destroy description: Delete a site group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this site group. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/sites/: get: operationId: dcim_sites_list description: Get a list of site objects. parameters: - in: query name: asn schema: type: array items: type: integer maximum: 4294967295 minimum: 1 format: int64 description: AS (ID) explode: true style: form - in: query name: asn__n schema: type: array items: type: integer maximum: 4294967295 minimum: 1 format: int64 description: AS (ID) explode: true style: form - in: query name: asn_id schema: type: array items: type: integer description: AS (ID) explode: true style: form - in: query name: asn_id__n schema: type: array items: type: integer description: AS (ID) explode: true style: form - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: facility schema: type: array items: type: string explode: true style: form - in: query name: facility__empty schema: type: boolean - in: query name: facility__ic schema: type: array items: type: string explode: true style: form - in: query name: facility__ie schema: type: array items: type: string explode: true style: form - in: query name: facility__iew schema: type: array items: type: string explode: true style: form - in: query name: facility__iregex schema: type: array items: type: string explode: true style: form - in: query name: facility__isw schema: type: array items: type: string explode: true style: form - in: query name: facility__n schema: type: array items: type: string explode: true style: form - in: query name: facility__nic schema: type: array items: type: string explode: true style: form - in: query name: facility__nie schema: type: array items: type: string explode: true style: form - in: query name: facility__niew schema: type: array items: type: string explode: true style: form - in: query name: facility__nisw schema: type: array items: type: string explode: true style: form - in: query name: facility__regex schema: type: array items: type: string explode: true style: form - in: query name: group schema: type: array items: type: string explode: true style: form - in: query name: group__n schema: type: array items: type: string explode: true style: form - in: query name: group_id schema: type: array items: type: string explode: true style: form - in: query name: group_id__n schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: latitude schema: type: array items: type: number format: double explode: true style: form - in: query name: latitude__empty schema: type: boolean - in: query name: latitude__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: latitude__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: latitude__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: latitude__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: latitude__n schema: type: array items: type: number format: double explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: longitude schema: type: array items: type: number format: double explode: true style: form - in: query name: longitude__empty schema: type: boolean - in: query name: longitude__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: longitude__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: longitude__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: longitude__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: longitude__n schema: type: array items: type: number format: double explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 1cf60831fbb35e7f explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: time_zone schema: type: array items: type: string explode: true style: form - in: query name: time_zone__ic schema: type: array items: type: string explode: true style: form - in: query name: time_zone__ie schema: type: array items: type: string explode: true style: form - in: query name: time_zone__iew schema: type: array items: type: string explode: true style: form - in: query name: time_zone__iregex schema: type: array items: type: string explode: true style: form - in: query name: time_zone__isw schema: type: array items: type: string explode: true style: form - in: query name: time_zone__n schema: type: array items: type: string explode: true style: form - in: query name: time_zone__nic schema: type: array items: type: string explode: true style: form - in: query name: time_zone__nie schema: type: array items: type: string explode: true style: form - in: query name: time_zone__niew schema: type: array items: type: string explode: true style: form - in: query name: time_zone__nisw schema: type: array items: type: string explode: true style: form - in: query name: time_zone__regex schema: type: array items: type: string explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSiteList' description: '' post: operationId: dcim_sites_create description: Post a list of site objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableSiteRequest' - type: array items: $ref: '#/components/schemas/WritableSiteRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableSiteRequest' - type: array items: $ref: '#/components/schemas/WritableSiteRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Site' description: '' put: operationId: dcim_sites_bulk_update description: Put a list of site objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SiteRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/SiteRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Site' description: '' patch: operationId: dcim_sites_bulk_partial_update description: Patch a list of site objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SiteRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/SiteRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Site' description: '' delete: operationId: dcim_sites_bulk_destroy description: Delete a list of site objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/SiteRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/SiteRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/sites/{id}/: get: operationId: dcim_sites_retrieve description: Get a site object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this site. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Site' description: '' put: operationId: dcim_sites_update description: Put a site object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this site. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableSiteRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableSiteRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Site' description: '' patch: operationId: dcim_sites_partial_update description: Patch a site object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this site. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableSiteRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableSiteRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Site' description: '' delete: operationId: dcim_sites_destroy description: Delete a site object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this site. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/virtual-chassis/: get: operationId: dcim_virtual_chassis_list description: Get a list of virtual chassis objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: domain schema: type: array items: type: string explode: true style: form - in: query name: domain__empty schema: type: boolean - in: query name: domain__ic schema: type: array items: type: string explode: true style: form - in: query name: domain__ie schema: type: array items: type: string explode: true style: form - in: query name: domain__iew schema: type: array items: type: string explode: true style: form - in: query name: domain__iregex schema: type: array items: type: string explode: true style: form - in: query name: domain__isw schema: type: array items: type: string explode: true style: form - in: query name: domain__n schema: type: array items: type: string explode: true style: form - in: query name: domain__nic schema: type: array items: type: string explode: true style: form - in: query name: domain__nie schema: type: array items: type: string explode: true style: form - in: query name: domain__niew schema: type: array items: type: string explode: true style: form - in: query name: domain__nisw schema: type: array items: type: string explode: true style: form - in: query name: domain__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: master schema: type: array items: type: string nullable: true description: Master (name) explode: true style: form - in: query name: master__n schema: type: array items: type: string nullable: true description: Master (name) explode: true style: form - in: query name: master_id schema: type: array items: type: integer nullable: true description: Master (ID) explode: true style: form - in: query name: master_id__n schema: type: array items: type: integer nullable: true description: Master (ID) explode: true style: form - in: query name: member_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: member_count__empty schema: type: boolean - in: query name: member_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: member_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: member_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: member_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: member_count__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site name (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVirtualChassisList' description: '' post: operationId: dcim_virtual_chassis_create description: Post a list of virtual chassis objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableVirtualChassisRequest' - type: array items: $ref: '#/components/schemas/WritableVirtualChassisRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableVirtualChassisRequest' - type: array items: $ref: '#/components/schemas/WritableVirtualChassisRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VirtualChassis' description: '' put: operationId: dcim_virtual_chassis_bulk_update description: Put a list of virtual chassis objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualChassisRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualChassisRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualChassis' description: '' patch: operationId: dcim_virtual_chassis_bulk_partial_update description: Patch a list of virtual chassis objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualChassisRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualChassisRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualChassis' description: '' delete: operationId: dcim_virtual_chassis_bulk_destroy description: Delete a list of virtual chassis objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualChassisRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualChassisRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/virtual-chassis/{id}/: get: operationId: dcim_virtual_chassis_retrieve description: Get a virtual chassis object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual chassis. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualChassis' description: '' put: operationId: dcim_virtual_chassis_update description: Put a virtual chassis object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual chassis. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVirtualChassisRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableVirtualChassisRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualChassis' description: '' patch: operationId: dcim_virtual_chassis_partial_update description: Patch a virtual chassis object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual chassis. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVirtualChassisRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableVirtualChassisRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualChassis' description: '' delete: operationId: dcim_virtual_chassis_destroy description: Delete a virtual chassis object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual chassis. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/virtual-device-contexts/: get: operationId: dcim_virtual_device_contexts_list description: Get a list of virtual device context objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: integer description: Device model explode: true style: form - in: query name: device__n schema: type: array items: type: integer description: Device model explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: VDC (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: VDC (ID) explode: true style: form - in: query name: has_primary_ip schema: type: boolean description: Has a primary IP - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: identifier schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: identifier__empty schema: type: boolean - in: query name: identifier__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: identifier__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: identifier__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: identifier__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: identifier__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_id schema: type: array items: type: integer description: Interface (ID) explode: true style: form - in: query name: interface_id__n schema: type: array items: type: integer description: Interface (ID) explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: primary_ip4 schema: type: array items: type: string description: Primary IPv4 (address) explode: true style: form - in: query name: primary_ip4__n schema: type: array items: type: string description: Primary IPv4 (address) explode: true style: form - in: query name: primary_ip4_id schema: type: array items: type: integer description: Primary IPv4 (ID) explode: true style: form - in: query name: primary_ip4_id__n schema: type: array items: type: integer description: Primary IPv4 (ID) explode: true style: form - in: query name: primary_ip6 schema: type: array items: type: string description: Primary IPv6 (address) explode: true style: form - in: query name: primary_ip6__n schema: type: array items: type: string description: Primary IPv6 (address) explode: true style: form - in: query name: primary_ip6_id schema: type: array items: type: integer description: Primary IPv6 (ID) explode: true style: form - in: query name: primary_ip6_id__n schema: type: array items: type: integer description: Primary IPv6 (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: status schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 0e2c0919d51b83cb explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVirtualDeviceContextList' description: '' post: operationId: dcim_virtual_device_contexts_create description: Post a list of virtual device context objects. tags: - dcim requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' - type: array items: $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' - type: array items: $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VirtualDeviceContext' description: '' put: operationId: dcim_virtual_device_contexts_bulk_update description: Put a list of virtual device context objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualDeviceContextRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualDeviceContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualDeviceContext' description: '' patch: operationId: dcim_virtual_device_contexts_bulk_partial_update description: Patch a list of virtual device context objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualDeviceContextRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualDeviceContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualDeviceContext' description: '' delete: operationId: dcim_virtual_device_contexts_bulk_destroy description: Delete a list of virtual device context objects. tags: - dcim requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualDeviceContextRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualDeviceContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/dcim/virtual-device-contexts/{id}/: get: operationId: dcim_virtual_device_contexts_retrieve description: Get a virtual device context object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual device context. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualDeviceContext' description: '' put: operationId: dcim_virtual_device_contexts_update description: Put a virtual device context object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual device context. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableVirtualDeviceContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualDeviceContext' description: '' patch: operationId: dcim_virtual_device_contexts_partial_update description: Patch a virtual device context object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual device context. required: true tags: - dcim requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVirtualDeviceContextRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableVirtualDeviceContextRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualDeviceContext' description: '' delete: operationId: dcim_virtual_device_contexts_destroy description: Delete a virtual device context object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual device context. required: true tags: - dcim security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body components: schemas: CableTermination: type: object description: Adds support for custom fields and tags. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true cable: type: integer readOnly: true cable_end: enum: - A - B type: string description: '* `A` - A * `B` - B' x-spec-enum-id: 1db84f9b93b261c8 readOnly: true title: End termination_type: type: string readOnly: true termination_id: type: integer readOnly: true termination: readOnly: true nullable: true connector: type: integer readOnly: true nullable: true positions: type: array items: type: integer maximum: 1024 minimum: 1 readOnly: true nullable: true created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - cable - cable_end - connector - created - display - id - last_updated - positions - termination - termination_id - termination_type - url FrontPortMappingRequest: type: object properties: position: type: integer rear_port: type: integer rear_port_position: type: integer maximum: 1024 minimum: 1 default: 1 required: - position - rear_port WritableDeviceRoleRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string minLength: 1 pattern: ^[0-9a-f]{6}$ maxLength: 6 vm_role: type: boolean description: Virtual machines may be assigned to this role config_template: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefConfigTemplateRequest' nullable: true nullable: true parent: type: integer nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string required: - name - slug InterfaceTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - virtual - bridge - lag - 100base-fx - 100base-lfx - 100base-tx - 100base-t1 - 1000base-bx10-d - 1000base-bx10-u - 1000base-cwdm - 1000base-cx - 1000base-dwdm - 1000base-ex - 1000base-lsx - 1000base-lx - 1000base-lx10 - 1000base-sx - 1000base-t - 1000base-tx - 1000base-zx - 2.5gbase-t - 5gbase-t - 10gbase-br-d - 10gbase-br-u - 10gbase-cu - 10gbase-cx4 - 10gbase-er - 10gbase-lr - 10gbase-lrm - 10gbase-lx4 - 10gbase-sr - 10gbase-t - 10gbase-zr - 25gbase-cr - 25gbase-er - 25gbase-lr - 25gbase-sr - 25gbase-t - 40gbase-cr4 - 40gbase-er4 - 40gbase-fr4 - 40gbase-lr4 - 40gbase-sr4 - 40gbase-sr4-bd - 50gbase-cr - 50gbase-er - 50gbase-fr - 50gbase-lr - 50gbase-sr - 100gbase-cr1 - 100gbase-cr2 - 100gbase-cr4 - 100gbase-cr10 - 100gbase-cwdm4 - 100gbase-dr - 100gbase-er4 - 100gbase-fr1 - 100gbase-lr1 - 100gbase-lr4 - 100gbase-sr1 - 100gbase-sr1.2 - 100gbase-sr2 - 100gbase-sr4 - 100gbase-sr10 - 100gbase-zr - 200gbase-cr2 - 200gbase-cr4 - 200gbase-dr4 - 200gbase-er4 - 200gbase-fr4 - 200gbase-lr4 - 200gbase-sr2 - 200gbase-sr4 - 200gbase-vr2 - 400gbase-cr4 - 400gbase-dr4 - 400gbase-er8 - 400gbase-fr4 - 400gbase-fr8 - 400gbase-lr4 - 400gbase-lr8 - 400gbase-sr4 - 400gbase-sr4_2 - 400gbase-sr8 - 400gbase-sr16 - 400gbase-vr4 - 400gbase-zr - 800gbase-cr8 - 800gbase-dr8 - 800gbase-sr8 - 800gbase-vr8 - 1.6tbase-cr8 - 1.6tbase-dr8 - 1.6tbase-dr8-2 - 100base-x-sfp - 1000base-x-gbic - 1000base-x-sfp - 2.5gbase-x-sfp - 10gbase-x-sfpp - 10gbase-x-xenpak - 10gbase-x-xfp - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 50gbase-x-sfp56 - 100gbase-x-cfp - 100gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cxp - 100gbase-x-cpak - 100gbase-x-dsfp - 100gbase-x-qsfp28 - 100gbase-x-qsfpdd - 100gbase-x-sfpdd - 200gbase-x-cfp2 - 200gbase-x-qsfp56 - 200gbase-x-qsfpdd - 400gbase-x-qsfp112 - 400gbase-x-qsfpdd - 400gbase-x-cdfp - 400gbase-x-cfp2 - 400gbase-x-cfp8 - 400gbase-x-osfp - 400gbase-x-osfp-rhs - 800gbase-x-osfp - 800gbase-x-qsfpdd - 1.6tbase-x-osfp1600 - 1.6tbase-x-osfp1600-rhs - 1.6tbase-x-qsfpdd1600 - 1000base-kx - 2.5gbase-kx - 5gbase-kr - 10gbase-kr - 10gbase-kx4 - 25gbase-kr - 40gbase-kr4 - 50gbase-kr - 100gbase-kp4 - 100gbase-kr2 - 100gbase-kr4 - 1.6tbase-kr8 - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - ieee802.11ay - ieee802.11be - ieee802.15.1 - ieee802.15.4 - other-wireless - gsm - cdma - lte - 4g - 5g - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 32gfc-sfpp - 64gfc-qsfpp - 64gfc-sfpdd - 64gfc-sfpp - 128gfc-qsfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - xdsl - docsis - moca - bpon - epon - 10g-epon - gpon - xg-pon - xgs-pon - ng-pon2 - 25g-pon - 50g-pon - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - cisco-stackwise-80 - cisco-stackwise-160 - cisco-stackwise-320 - cisco-stackwise-480 - cisco-stackwise-1t - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string description: '* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) * `100base-fx` - 100BASE-FX (10/100ME) * `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) * `100base-t1` - 100BASE-T1 (10/100ME) * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) * `1000base-cwdm` - 1000BASE-CWDM (1GE) * `1000base-cx` - 1000BASE-CX (1GE DAC) * `1000base-dwdm` - 1000BASE-DWDM (1GE) * `1000base-ex` - 1000BASE-EX (1GE) * `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) * `1000base-lx10` - 1000BASE-LX10/LH (1GE) * `1000base-sx` - 1000BASE-SX (1GE) * `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) * `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) * `10gbase-er` - 10GBASE-ER (10GE) * `10gbase-lr` - 10GBASE-LR (10GE) * `10gbase-lrm` - 10GBASE-LRM (10GE) * `10gbase-lx4` - 10GBASE-LX4 (10GE) * `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) * `10gbase-zr` - 10GBASE-ZR (10GE) * `25gbase-cr` - 25GBASE-CR (25GE DAC) * `25gbase-er` - 25GBASE-ER (25GE) * `25gbase-lr` - 25GBASE-LR (25GE) * `25gbase-sr` - 25GBASE-SR (25GE) * `25gbase-t` - 25GBASE-T (25GE) * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) * `40gbase-er4` - 40GBASE-ER4 (40GE) * `40gbase-fr4` - 40GBASE-FR4 (40GE) * `40gbase-lr4` - 40GBASE-LR4 (40GE) * `40gbase-sr4` - 40GBASE-SR4 (40GE) * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) * `50gbase-cr` - 50GBASE-CR (50GE DAC) * `50gbase-er` - 50GBASE-ER (50GE) * `50gbase-fr` - 50GBASE-FR (50GE) * `50gbase-lr` - 50GBASE-LR (50GE) * `50gbase-sr` - 50GBASE-SR (50GE) * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) * `100gbase-dr` - 100GBASE-DR (100GE) * `100gbase-er4` - 100GBASE-ER4 (100GE) * `100gbase-fr1` - 100GBASE-FR1 (100GE) * `100gbase-lr1` - 100GBASE-LR1 (100GE) * `100gbase-lr4` - 100GBASE-LR4 (100GE) * `100gbase-sr1` - 100GBASE-SR1 (100GE) * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) * `100gbase-sr2` - 100GBASE-SR2 (100GE) * `100gbase-sr4` - 100GBASE-SR4 (100GE) * `100gbase-sr10` - 100GBASE-SR10 (100GE) * `100gbase-zr` - 100GBASE-ZR (100GE) * `200gbase-cr2` - 200GBASE-CR2 (200GE) * `200gbase-cr4` - 200GBASE-CR4 (200GE) * `200gbase-dr4` - 200GBASE-DR4 (200GE) * `200gbase-er4` - 200GBASE-ER4 (200GE) * `200gbase-fr4` - 200GBASE-FR4 (200GE) * `200gbase-lr4` - 200GBASE-LR4 (200GE) * `200gbase-sr2` - 200GBASE-SR2 (200GE) * `200gbase-sr4` - 200GBASE-SR4 (200GE) * `200gbase-vr2` - 200GBASE-VR2 (200GE) * `400gbase-cr4` - 400GBASE-CR4 (400GE) * `400gbase-dr4` - 400GBASE-DR4 (400GE) * `400gbase-er8` - 400GBASE-ER8 (400GE) * `400gbase-fr4` - 400GBASE-FR4 (400GE) * `400gbase-fr8` - 400GBASE-FR8 (400GE) * `400gbase-lr4` - 400GBASE-LR4 (400GE) * `400gbase-lr8` - 400GBASE-LR8 (400GE) * `400gbase-sr4` - 400GBASE-SR4 (400GE) * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) * `400gbase-sr8` - 400GBASE-SR8 (400GE) * `400gbase-sr16` - 400GBASE-SR16 (400GE) * `400gbase-vr4` - 400GBASE-VR4 (400GE) * `400gbase-zr` - 400GBASE-ZR (400GE) * `800gbase-cr8` - 800GBASE-CR8 (800GE) * `800gbase-dr8` - 800GBASE-DR8 (800GE) * `800gbase-sr8` - 800GBASE-SR8 (800GE) * `800gbase-vr8` - 800GBASE-VR8 (800GE) * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) * `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) * `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) * `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) * `100gbase-x-sfpdd` - SFP-DD (100GE) * `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) * `400gbase-x-cdfp` - CDFP (400GE) * `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) * `400gbase-x-osfp` - OSFP (400GE) * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) * `800gbase-x-qsfpdd` - QSFP-DD (800GE) * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) * `10gbase-kr` - 10GBASE-KR (10GE) * `10gbase-kx4` - 10GBASE-KX4 (10GE) * `25gbase-kr` - 25GBASE-KR (25GE) * `40gbase-kr4` - 40GBASE-KR4 (40GE) * `50gbase-kr` - 50GBASE-KR (50GE) * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) * `ieee802.11ad` - IEEE 802.11ad (WiGig) * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) * `ieee802.11ay` - IEEE 802.11ay (WiGig) * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) * `gsm` - GSM * `cdma` - CDMA * `lte` - LTE * `4g` - 4G * `5g` - 5G * `sonet-oc3` - OC-3/STM-1 * `sonet-oc12` - OC-12/STM-4 * `sonet-oc48` - OC-48/STM-16 * `sonet-oc192` - OC-192/STM-64 * `sonet-oc768` - OC-768/STM-256 * `sonet-oc1920` - OC-1920/STM-640 * `sonet-oc3840` - OC-3840/STM-1234 * `1gfc-sfp` - SFP (1GFC) * `2gfc-sfp` - SFP (2GFC) * `4gfc-sfp` - SFP (4GFC) * `8gfc-sfpp` - SFP+ (8GFC) * `16gfc-sfpp` - SFP+ (16GFC) * `32gfc-sfp28` - SFP28 (32GFC) * `32gfc-sfpp` - SFP+ (32GFC) * `64gfc-qsfpp` - QSFP+ (64GFC) * `64gfc-sfpdd` - SFP-DD (64GFC) * `64gfc-sfpp` - SFP+ (64GFC) * `128gfc-qsfp28` - QSFP28 (128GFC) * `infiniband-sdr` - SDR (2 Gbps) * `infiniband-ddr` - DDR (4 Gbps) * `infiniband-qdr` - QDR (8 Gbps) * `infiniband-fdr10` - FDR10 (10 Gbps) * `infiniband-fdr` - FDR (13.5 Gbps) * `infiniband-edr` - EDR (25 Gbps) * `infiniband-hdr` - HDR (50 Gbps) * `infiniband-ndr` - NDR (100 Gbps) * `infiniband-xdr` - XDR (250 Gbps) * `t1` - T1 (1.544 Mbps) * `e1` - E1 (2.048 Mbps) * `t3` - T3 (45 Mbps) * `e3` - E3 (34 Mbps) * `xdsl` - xDSL * `docsis` - DOCSIS * `moca` - MoCA * `bpon` - BPON (622 Mbps / 155 Mbps) * `epon` - EPON (1 Gbps) * `10g-epon` - 10G-EPON (10 Gbps) * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) * `xgs-pon` - XGS-PON (10 Gbps) * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) * `25g-pon` - 25G-PON (25 Gbps) * `50g-pon` - 50G-PON (50 Gbps) * `cisco-stackwise` - Cisco StackWise * `cisco-stackwise-plus` - Cisco StackWise Plus * `cisco-flexstack` - Cisco FlexStack * `cisco-flexstack-plus` - Cisco FlexStack Plus * `cisco-stackwise-80` - Cisco StackWise-80 * `cisco-stackwise-160` - Cisco StackWise-160 * `cisco-stackwise-320` - Cisco StackWise-320 * `cisco-stackwise-480` - Cisco StackWise-480 * `cisco-stackwise-1t` - Cisco StackWise-1T * `juniper-vcp` - Juniper VCP * `extreme-summitstack` - Extreme SummitStack * `extreme-summitstack-128` - Extreme SummitStack-128 * `extreme-summitstack-256` - Extreme SummitStack-256 * `extreme-summitstack-512` - Extreme SummitStack-512 * `other` - Other' x-spec-enum-id: b067eb1f050c6ae9 enabled: type: boolean mgmt_only: type: boolean title: Management only description: type: string maxLength: 200 bridge: allOf: - $ref: '#/components/schemas/NestedInterfaceTemplateRequest' nullable: true poe_mode: enum: - pd - pse - '' - null type: string description: '* `pd` - PD * `pse` - PSE' x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true poe_type: enum: - type1-ieee802.3af - type2-ieee802.3at - type3-ieee802.3bt - type4-ieee802.3bt - passive-24v-2pair - passive-24v-4pair - passive-48v-2pair - passive-48v-4pair - '' - null type: string description: '* `type1-ieee802.3af` - 802.3af (Type 1) * `type2-ieee802.3at` - 802.3at (Type 2) * `type3-ieee802.3bt` - 802.3bt (Type 3) * `type4-ieee802.3bt` - 802.3bt (Type 4) * `passive-24v-2pair` - Passive 24V (2-pair) * `passive-24v-4pair` - Passive 24V (4-pair) * `passive-48v-2pair` - Passive 48V (2-pair) * `passive-48v-4pair` - Passive 48V (4-pair)' x-spec-enum-id: 5473d57885f237ab nullable: true rf_role: enum: - ap - station - '' - null type: string description: '* `ap` - Access point * `station` - Station' x-spec-enum-id: d2772dbea88b0fb1 nullable: true required: - name - type BriefPowerPanelRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name BriefDeviceTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' model: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - manufacturer - model - slug NestedLocation: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ _depth: type: integer readOnly: true title: ' depth' required: - _depth - display - display_url - id - name - slug - url BriefManufacturerRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug WritableConsolePortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' - null type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: type: string maxLength: 200 required: - name ConsoleServerPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 speed: enum: - 1200 - 2400 - 4800 - 9600 - 19200 - 38400 - 57600 - 115200 - null type: integer description: '* `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' x-spec-enum-id: ab6d9635c131a378 nullable: true description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name GenericObjectRequest: type: object description: Minimal representation of some generic object identified by ContentType and PK. properties: object_type: type: string object_id: type: integer required: - object_id - object_type PaginatedPowerOutletList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/PowerOutlet' PaginatedInventoryItemList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/InventoryItem' RearPortTemplateMapping: type: object properties: position: type: integer front_port: type: integer front_port_position: type: integer maximum: 1024 minimum: 1 default: 1 required: - front_port - position FrontPortTemplateMappingRequest: type: object properties: position: type: integer rear_port: type: integer rear_port_position: type: integer maximum: 1024 minimum: 1 default: 1 required: - position - rear_port RackType: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true manufacturer: $ref: '#/components/schemas/BriefManufacturer' model: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 form_factor: type: object properties: value: enum: - 2-post-frame - 4-post-frame - 4-post-cabinet - wall-frame - wall-frame-vertical - wall-cabinet - wall-cabinet-vertical - '' - null type: string 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)' x-spec-enum-id: 8a902fde21d48841 label: type: string enum: - 2-post frame - 4-post frame - 4-post cabinet - Wall-mounted frame - Wall-mounted frame (vertical) - Wall-mounted cabinet - Wall-mounted cabinet (vertical) nullable: true width: type: object properties: value: enum: - 10 - 19 - 21 - 23 type: integer description: '* `10` - 10 inches * `19` - 19 inches * `21` - 21 inches * `23` - 23 inches' x-spec-enum-id: 9b322795f297a9c3 label: type: string enum: - 10 inches - 19 inches - 21 inches - 23 inches u_height: type: integer maximum: 100 minimum: 1 title: Height (U) description: Height in rack units starting_unit: type: integer maximum: 32767 minimum: 1 description: Starting unit for rack desc_units: type: boolean title: Descending units description: Units are numbered top-to-bottom outer_width: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (width) outer_height: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (height) outer_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (depth) outer_unit: type: object properties: value: enum: - mm - in - '' - null type: string description: '* `mm` - Millimeters * `in` - Inches' x-spec-enum-id: 3d701848b66312c3 label: type: string enum: - Millimeters - Inches nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true max_weight: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Maximum load capacity for the rack weight_unit: type: object properties: value: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 label: type: string enum: - Kilograms - Grams - Pounds - Ounces nullable: true mounting_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails. owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true rack_count: type: integer readOnly: true required: - created - display - display_url - id - last_updated - manufacturer - model - rack_count - slug - url BriefClusterRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name NestedInterface: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: allOf: - $ref: '#/components/schemas/NestedDevice' readOnly: true name: type: string maxLength: 64 cable: type: integer nullable: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - device - display - display_url - id - name - url PatchedWritablePowerOutletRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c5 - iec-60320-c7 - iec-60320-c13 - iec-60320-c15 - iec-60320-c17 - iec-60320-c19 - iec-60320-c21 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15r - nema-5-15r - nema-5-20r - nema-5-30r - nema-5-50r - nema-6-15r - nema-6-20r - nema-6-30r - nema-6-50r - nema-10-30r - nema-10-50r - nema-14-20r - nema-14-30r - nema-14-50r - nema-14-60r - nema-15-15r - nema-15-20r - nema-15-30r - nema-15-50r - nema-15-60r - nema-l1-15r - nema-l5-15r - nema-l5-20r - nema-l5-30r - nema-l5-50r - nema-l6-15r - nema-l6-20r - nema-l6-30r - nema-l6-50r - nema-l10-30r - nema-l14-20r - nema-l14-30r - nema-l14-50r - nema-l14-60r - nema-l15-20r - nema-l15-30r - nema-l15-50r - nema-l15-60r - nema-l21-20r - nema-l21-30r - nema-l22-20r - nema-l22-30r - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ita-e - ita-f - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - ita-multistandard - usb-a - usb-micro-b - usb-c - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - eaton-c39 - hdot-cx - saf-d-grid - neutrik-powercon-20a - neutrik-powercon-32a - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: 'Physical port type * `iec-60320-c5` - C5 * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 * `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15r` - NEMA 1-15R * `nema-5-15r` - NEMA 5-15R * `nema-5-20r` - NEMA 5-20R * `nema-5-30r` - NEMA 5-30R * `nema-5-50r` - NEMA 5-50R * `nema-6-15r` - NEMA 6-15R * `nema-6-20r` - NEMA 6-20R * `nema-6-30r` - NEMA 6-30R * `nema-6-50r` - NEMA 6-50R * `nema-10-30r` - NEMA 10-30R * `nema-10-50r` - NEMA 10-50R * `nema-14-20r` - NEMA 14-20R * `nema-14-30r` - NEMA 14-30R * `nema-14-50r` - NEMA 14-50R * `nema-14-60r` - NEMA 14-60R * `nema-15-15r` - NEMA 15-15R * `nema-15-20r` - NEMA 15-20R * `nema-15-30r` - NEMA 15-30R * `nema-15-50r` - NEMA 15-50R * `nema-15-60r` - NEMA 15-60R * `nema-l1-15r` - NEMA L1-15R * `nema-l5-15r` - NEMA L5-15R * `nema-l5-20r` - NEMA L5-20R * `nema-l5-30r` - NEMA L5-30R * `nema-l5-50r` - NEMA L5-50R * `nema-l6-15r` - NEMA L6-15R * `nema-l6-20r` - NEMA L6-20R * `nema-l6-30r` - NEMA L6-30R * `nema-l6-50r` - NEMA L6-50R * `nema-l10-30r` - NEMA L10-30R * `nema-l14-20r` - NEMA L14-20R * `nema-l14-30r` - NEMA L14-30R * `nema-l14-50r` - NEMA L14-50R * `nema-l14-60r` - NEMA L14-60R * `nema-l15-20r` - NEMA L15-20R * `nema-l15-30r` - NEMA L15-30R * `nema-l15-50r` - NEMA L15-50R * `nema-l15-60r` - NEMA L15-60R * `nema-l21-20r` - NEMA L21-20R * `nema-l21-30r` - NEMA L21-30R * `nema-l22-20r` - NEMA L22-20R * `nema-l22-30r` - NEMA L22-30R * `CS6360C` - CS6360C * `CS6364C` - CS6364C * `CS8164C` - CS8164C * `CS8264C` - CS8264C * `CS8364C` - CS8364C * `CS8464C` - CS8464C * `ita-e` - ITA Type E (CEE 7/5) * `ita-f` - ITA Type F (CEE 7/3) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `ita-multistandard` - ITA Multistandard * `usb-a` - USB Type A * `usb-micro-b` - USB Micro B * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 * `hdot-cx` - HDOT Cx * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20a` - Neutrik powerCON (20A) * `neutrik-powercon-32a` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' status: enum: - enabled - disabled - faulty type: string description: '* `enabled` - Enabled * `disabled` - Disabled * `faulty` - Faulty' x-spec-enum-id: d60dce16858f3c69 color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 power_port: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPowerPortRequest' nullable: true nullable: true feed_leg: enum: - A - B - C - '' - null type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: 'Phase (for three-phase feeds) * `A` - A * `B` - B * `C` - C' description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} NestedModuleBayRequest: type: object 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.' properties: name: type: string minLength: 1 maxLength: 64 required: - name ModuleBayTemplate: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device_type: allOf: - $ref: '#/components/schemas/BriefDeviceType' nullable: true module_type: allOf: - $ref: '#/components/schemas/BriefModuleType' nullable: true name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 position: type: string description: Identifier to reference when renaming installed components maxLength: 30 description: type: string maxLength: 200 created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - id - last_updated - name - url CableRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: type: enum: - cat3 - cat5 - cat5e - cat6 - cat6a - cat7 - cat7a - cat8 - mrj21-trunk - dac-active - dac-passive - coaxial - rg-6 - rg-8 - rg-11 - rg-59 - rg-62 - rg-213 - lmr-100 - lmr-200 - lmr-400 - mmf - mmf-om1 - mmf-om2 - mmf-om3 - mmf-om4 - mmf-om5 - smf - smf-os1 - smf-os2 - aoc - power - usb - '' - null type: string 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' x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true a_terminations: type: array items: $ref: '#/components/schemas/GenericObjectRequest' b_terminations: type: array items: $ref: '#/components/schemas/GenericObjectRequest' status: enum: - connected - planned - decommissioning type: string description: '* `connected` - Connected * `planned` - Planned * `decommissioning` - Decommissioning' x-spec-enum-id: 80d251a40f3a3144 profile: enum: - single-1c1p - single-1c2p - single-1c4p - single-1c6p - single-1c8p - single-1c12p - single-1c16p - trunk-2c1p - trunk-2c2p - trunk-2c4p - trunk-2c4p-shuffle - trunk-2c6p - trunk-2c8p - trunk-2c12p - trunk-4c1p - trunk-4c2p - trunk-4c4p - trunk-4c4p-shuffle - trunk-4c6p - trunk-4c8p - trunk-8c4p - breakout-1c2p-2c1p - breakout-1c4p-4c1p - breakout-1c6p-6c1p - breakout-2c4p-8c1p-shuffle type: string 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)' x-spec-enum-id: f566e6df6572f5d0 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true label: type: string maxLength: 100 color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 length: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true length_unit: enum: - km - m - cm - mi - ft - in - '' - null type: string description: '* `km` - Kilometers * `m` - Meters * `cm` - Centimeters * `mi` - Miles * `ft` - Feet * `in` - Inches' x-spec-enum-id: 6e7645525ba02462 nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefIPAddressRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: address: type: string minLength: 1 description: type: string maxLength: 200 required: - address PowerPort: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' module: allOf: - $ref: '#/components/schemas/BriefModule' nullable: true name: type: string maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - iec-60320-c6 - iec-60320-c8 - iec-60320-c14 - iec-60320-c16 - iec-60320-c18 - iec-60320-c20 - iec-60320-c22 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15p - nema-5-15p - nema-5-20p - nema-5-30p - nema-5-50p - nema-6-15p - nema-6-20p - nema-6-30p - nema-6-50p - nema-10-30p - nema-10-50p - nema-14-20p - nema-14-30p - nema-14-50p - nema-14-60p - nema-15-15p - nema-15-20p - nema-15-30p - nema-15-50p - nema-15-60p - nema-l1-15p - nema-l5-15p - nema-l5-20p - nema-l5-30p - nema-l5-50p - nema-l6-15p - nema-l6-20p - nema-l6-30p - nema-l6-50p - nema-l10-30p - nema-l14-20p - nema-l14-30p - nema-l14-50p - nema-l14-60p - nema-l15-20p - nema-l15-30p - nema-l15-50p - nema-l15-60p - nema-l21-20p - nema-l21-30p - nema-l22-20p - nema-l22-30p - cs6361c - cs6365c - cs8165c - cs8265c - cs8365c - cs8465c - ita-c - ita-e - ita-f - ita-ef - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - usb-3-b - usb-3-micro-b - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - saf-d-grid - neutrik-powercon-20 - neutrik-powercon-32 - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c6` - C6 * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 * `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15p` - NEMA 1-15P * `nema-5-15p` - NEMA 5-15P * `nema-5-20p` - NEMA 5-20P * `nema-5-30p` - NEMA 5-30P * `nema-5-50p` - NEMA 5-50P * `nema-6-15p` - NEMA 6-15P * `nema-6-20p` - NEMA 6-20P * `nema-6-30p` - NEMA 6-30P * `nema-6-50p` - NEMA 6-50P * `nema-10-30p` - NEMA 10-30P * `nema-10-50p` - NEMA 10-50P * `nema-14-20p` - NEMA 14-20P * `nema-14-30p` - NEMA 14-30P * `nema-14-50p` - NEMA 14-50P * `nema-14-60p` - NEMA 14-60P * `nema-15-15p` - NEMA 15-15P * `nema-15-20p` - NEMA 15-20P * `nema-15-30p` - NEMA 15-30P * `nema-15-50p` - NEMA 15-50P * `nema-15-60p` - NEMA 15-60P * `nema-l1-15p` - NEMA L1-15P * `nema-l5-15p` - NEMA L5-15P * `nema-l5-20p` - NEMA L5-20P * `nema-l5-30p` - NEMA L5-30P * `nema-l5-50p` - NEMA L5-50P * `nema-l6-15p` - NEMA L6-15P * `nema-l6-20p` - NEMA L6-20P * `nema-l6-30p` - NEMA L6-30P * `nema-l6-50p` - NEMA L6-50P * `nema-l10-30p` - NEMA L10-30P * `nema-l14-20p` - NEMA L14-20P * `nema-l14-30p` - NEMA L14-30P * `nema-l14-50p` - NEMA L14-50P * `nema-l14-60p` - NEMA L14-60P * `nema-l15-20p` - NEMA L15-20P * `nema-l15-30p` - NEMA L15-30P * `nema-l15-50p` - NEMA L15-50P * `nema-l15-60p` - NEMA L15-60P * `nema-l21-20p` - NEMA L21-20P * `nema-l21-30p` - NEMA L21-30P * `nema-l22-20p` - NEMA L22-20P * `nema-l22-30p` - NEMA L22-30P * `cs6361c` - CS6361C * `cs6365c` - CS6365C * `cs8165c` - CS8165C * `cs8265c` - CS8265C * `cs8365c` - CS8365C * `cs8465c` - CS8465C * `ita-c` - ITA Type C (CEE 7/16) * `ita-e` - ITA Type E (CEE 7/6) * `ita-f` - ITA Type F (CEE 7/4) * `ita-ef` - ITA Type E/F (CEE 7/7) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `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 * `usb-3-b` - USB 3.0 Type B * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20` - Neutrik powerCON (20A) * `neutrik-powercon-32` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: aadcbe6ca854c1ed label: type: string enum: - C6 - C8 - C14 - C16 - C18 - C20 - C22 - P+N+E 4H - P+N+E 6H - P+N+E 9H - 2P+E 4H - 2P+E 6H - 2P+E 9H - 3P+E 4H - 3P+E 6H - 3P+E 9H - 3P+N+E 4H - 3P+N+E 6H - 3P+N+E 9H - IEC 60906-1 - 2P+T 10A (NBR 14136) - 2P+T 20A (NBR 14136) - NEMA 1-15P - NEMA 5-15P - NEMA 5-20P - NEMA 5-30P - NEMA 5-50P - NEMA 6-15P - NEMA 6-20P - NEMA 6-30P - NEMA 6-50P - NEMA 10-30P - NEMA 10-50P - NEMA 14-20P - NEMA 14-30P - NEMA 14-50P - NEMA 14-60P - NEMA 15-15P - NEMA 15-20P - NEMA 15-30P - NEMA 15-50P - NEMA 15-60P - NEMA L1-15P - NEMA L5-15P - NEMA L5-20P - NEMA L5-30P - NEMA L5-50P - NEMA L6-15P - NEMA L6-20P - NEMA L6-30P - NEMA L6-50P - NEMA L10-30P - NEMA L14-20P - NEMA L14-30P - NEMA L14-50P - NEMA L14-60P - NEMA L15-20P - NEMA L15-30P - NEMA L15-50P - NEMA L15-60P - NEMA L21-20P - NEMA L21-30P - NEMA L22-20P - NEMA L22-30P - CS6361C - CS6365C - CS8165C - CS8265C - CS8365C - CS8465C - ITA Type C (CEE 7/16) - ITA Type E (CEE 7/6) - ITA Type F (CEE 7/4) - ITA Type E/F (CEE 7/7) - ITA Type G (BS 1363) - ITA Type H - ITA Type I - ITA Type J - ITA Type K - ITA Type L (CEI 23-50) - ITA Type M (BS 546) - ITA Type N - ITA Type O - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB Micro AB - USB 3.0 Type B - USB 3.0 Micro B - Molex Micro-Fit 1x2 - Molex Micro-Fit 2x2 - Molex Micro-Fit 2x3 - Molex Micro-Fit 2x4 - DC Terminal - Saf-D-Grid - Neutrik powerCON (20A) - Neutrik powerCON (32A) - Neutrik powerCON TRUE1 - Neutrik powerCON TRUE1 TOP - Ubiquiti SmartPower - Hardwired - Other nullable: true maximum_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Maximum power draw (watts) allocated_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Allocated power draw (watts) description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected cable: allOf: - $ref: '#/components/schemas/BriefCable' readOnly: true nullable: true cable_end: type: string readOnly: true link_peers: type: array items: {} readOnly: true link_peers_type: type: string description: Return the type of the peer link terminations, or None. readOnly: true nullable: true connected_endpoints: type: array items: {} nullable: true readOnly: true connected_endpoints_type: type: string readOnly: true nullable: true connected_endpoints_reachable: type: boolean readOnly: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - cable - cable_end - connected_endpoints - connected_endpoints_reachable - connected_endpoints_type - created - device - display - display_url - id - last_updated - link_peers - link_peers_type - name - url PatchedWritableRackReservationRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: rack: oneOf: - type: integer - $ref: '#/components/schemas/BriefRackRequest' units: type: array items: type: integer maximum: 32767 minimum: 0 status: enum: - pending - active - stale type: string description: '* `pending` - Pending * `active` - Active * `stale` - Stale' x-spec-enum-id: ed6038a4deee151c user: oneOf: - type: integer - $ref: '#/components/schemas/BriefUserRequest' tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string minLength: 1 maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedCableList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Cable' BriefModuleTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: profile: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeProfileRequest' nullable: true nullable: true manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' model: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - manufacturer - model PatchedInventoryItemTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceTypeRequest' parent: type: integer nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefInventoryItemRoleRequest' nullable: true nullable: true manufacturer: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefManufacturerRequest' nullable: true nullable: true part_id: type: string description: Manufacturer-assigned part identifier maxLength: 50 description: type: string maxLength: 200 component_type: type: string nullable: true component_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true InventoryItemRole: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true inventoryitem_count: type: integer format: int64 readOnly: true required: - created - display - display_url - id - inventoryitem_count - last_updated - name - slug - url PaginatedModuleTypeProfileList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ModuleTypeProfile' PatchedWritableRearPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 front_ports: type: array items: $ref: '#/components/schemas/RearPortMappingRequest' description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} WritablePowerOutletTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c5 - iec-60320-c7 - iec-60320-c13 - iec-60320-c15 - iec-60320-c17 - iec-60320-c19 - iec-60320-c21 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15r - nema-5-15r - nema-5-20r - nema-5-30r - nema-5-50r - nema-6-15r - nema-6-20r - nema-6-30r - nema-6-50r - nema-10-30r - nema-10-50r - nema-14-20r - nema-14-30r - nema-14-50r - nema-14-60r - nema-15-15r - nema-15-20r - nema-15-30r - nema-15-50r - nema-15-60r - nema-l1-15r - nema-l5-15r - nema-l5-20r - nema-l5-30r - nema-l5-50r - nema-l6-15r - nema-l6-20r - nema-l6-30r - nema-l6-50r - nema-l10-30r - nema-l14-20r - nema-l14-30r - nema-l14-50r - nema-l14-60r - nema-l15-20r - nema-l15-30r - nema-l15-50r - nema-l15-60r - nema-l21-20r - nema-l21-30r - nema-l22-20r - nema-l22-30r - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ita-e - ita-f - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - ita-multistandard - usb-a - usb-micro-b - usb-c - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - eaton-c39 - hdot-cx - saf-d-grid - neutrik-powercon-20a - neutrik-powercon-32a - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c5` - C5 * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 * `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15r` - NEMA 1-15R * `nema-5-15r` - NEMA 5-15R * `nema-5-20r` - NEMA 5-20R * `nema-5-30r` - NEMA 5-30R * `nema-5-50r` - NEMA 5-50R * `nema-6-15r` - NEMA 6-15R * `nema-6-20r` - NEMA 6-20R * `nema-6-30r` - NEMA 6-30R * `nema-6-50r` - NEMA 6-50R * `nema-10-30r` - NEMA 10-30R * `nema-10-50r` - NEMA 10-50R * `nema-14-20r` - NEMA 14-20R * `nema-14-30r` - NEMA 14-30R * `nema-14-50r` - NEMA 14-50R * `nema-14-60r` - NEMA 14-60R * `nema-15-15r` - NEMA 15-15R * `nema-15-20r` - NEMA 15-20R * `nema-15-30r` - NEMA 15-30R * `nema-15-50r` - NEMA 15-50R * `nema-15-60r` - NEMA 15-60R * `nema-l1-15r` - NEMA L1-15R * `nema-l5-15r` - NEMA L5-15R * `nema-l5-20r` - NEMA L5-20R * `nema-l5-30r` - NEMA L5-30R * `nema-l5-50r` - NEMA L5-50R * `nema-l6-15r` - NEMA L6-15R * `nema-l6-20r` - NEMA L6-20R * `nema-l6-30r` - NEMA L6-30R * `nema-l6-50r` - NEMA L6-50R * `nema-l10-30r` - NEMA L10-30R * `nema-l14-20r` - NEMA L14-20R * `nema-l14-30r` - NEMA L14-30R * `nema-l14-50r` - NEMA L14-50R * `nema-l14-60r` - NEMA L14-60R * `nema-l15-20r` - NEMA L15-20R * `nema-l15-30r` - NEMA L15-30R * `nema-l15-50r` - NEMA L15-50R * `nema-l15-60r` - NEMA L15-60R * `nema-l21-20r` - NEMA L21-20R * `nema-l21-30r` - NEMA L21-30R * `nema-l22-20r` - NEMA L22-20R * `nema-l22-30r` - NEMA L22-30R * `CS6360C` - CS6360C * `CS6364C` - CS6364C * `CS8164C` - CS8164C * `CS8264C` - CS8264C * `CS8364C` - CS8364C * `CS8464C` - CS8464C * `ita-e` - ITA Type E (CEE 7/5) * `ita-f` - ITA Type F (CEE 7/3) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `ita-multistandard` - ITA Multistandard * `usb-a` - USB Type A * `usb-micro-b` - USB Micro B * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 * `hdot-cx` - HDOT Cx * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20a` - Neutrik powerCON (20A) * `neutrik-powercon-32a` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: db3e4eb2b93615f8 nullable: true color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 power_port: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPowerPortTemplateRequest' nullable: true nullable: true feed_leg: enum: - A - B - C - '' - null type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: 'Phase (for three-phase feeds) * `A` - A * `B` - B * `C` - C' description: type: string maxLength: 200 required: - name PaginatedPowerPortList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/PowerPort' RearPortMappingRequest: type: object properties: position: type: integer front_port: type: integer front_port_position: type: integer maximum: 1024 minimum: 1 default: 1 required: - front_port - position RearPortTemplateMappingRequest: type: object properties: position: type: integer front_port: type: integer front_port_position: type: integer maximum: 1024 minimum: 1 default: 1 required: - front_port - position VLAN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true site: allOf: - $ref: '#/components/schemas/BriefSite' nullable: true group: allOf: - $ref: '#/components/schemas/BriefVLANGroup' nullable: true vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string maxLength: 64 tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true status: type: object properties: value: enum: - active - reserved - deprecated type: string description: '* `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' x-spec-enum-id: ca933c38b935e547 label: type: string enum: - Active - Reserved - Deprecated role: allOf: - $ref: '#/components/schemas/BriefRole' nullable: true description: type: string maxLength: 200 qinq_role: type: object properties: value: enum: - svlan - cvlan - null type: string description: '* `svlan` - Service * `cvlan` - Customer' x-spec-enum-id: fa0abd59fb1a7312 label: type: string enum: - Service - Customer nullable: true qinq_svlan: allOf: - $ref: '#/components/schemas/NestedVLAN' nullable: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string l2vpn_termination: allOf: - $ref: '#/components/schemas/BriefL2VPNTermination' readOnly: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true prefix_count: type: integer format: int64 readOnly: true required: - created - display - display_url - id - l2vpn_termination - last_updated - name - prefix_count - url - vid VirtualDeviceContextRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 64 device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' identifier: type: integer maximum: 32767 minimum: 0 nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true primary_ip4: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true primary_ip6: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true status: enum: - active - planned - offline type: string description: '* `active` - Active * `planned` - Planned * `offline` - Offline' x-spec-enum-id: 0e2c0919d51b83cb description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name - status PowerPanel: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true site: $ref: '#/components/schemas/BriefSite' location: allOf: - $ref: '#/components/schemas/BriefLocation' nullable: true name: type: string maxLength: 100 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} powerfeed_count: type: integer format: int64 readOnly: true created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - name - powerfeed_count - site - url PaginatedPowerPortTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/PowerPortTemplate' NestedInterfaceRequest: type: object 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.' properties: name: type: string minLength: 1 maxLength: 64 cable: type: integer nullable: true required: - name NestedModuleBay: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 64 required: - display - display_url - id - name - url BriefPowerPortTemplateRequest: type: object 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)' properties: name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 description: type: string maxLength: 200 required: - name PatchedModuleBayTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 position: type: string description: Identifier to reference when renaming installed components maxLength: 30 description: type: string maxLength: 200 PatchedWritableModuleTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: profile: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeProfileRequest' nullable: true nullable: true manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' model: type: string minLength: 1 maxLength: 100 part_number: type: string description: Discrete part number (optional) maxLength: 50 airflow: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - passive - '' - null type: string 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' x-spec-enum-id: 5ad4e700c656b09d nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true description: type: string maxLength: 200 attributes: nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedDeviceWithConfigContextList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DeviceWithConfigContext' BriefRackRoleRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug BriefRackType: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true manufacturer: $ref: '#/components/schemas/BriefManufacturer' model: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 rack_count: type: integer readOnly: true required: - display - id - manufacturer - model - rack_count - slug - url NestedRegionRequest: type: object 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.' properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ required: - name - slug ConsolePortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 description: type: string maxLength: 200 required: - name PatchedWritableLocationRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ site: oneOf: - type: integer - $ref: '#/components/schemas/BriefSiteRequest' parent: type: integer nullable: true status: enum: - planned - staging - active - decommissioning - retired type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `retired` - Retired' x-spec-enum-id: 1cf60831fbb35e7f tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true facility: type: string description: Local facility ID or description maxLength: 50 description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string BriefRole: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 prefix_count: type: integer format: int64 readOnly: true vlan_count: type: integer format: int64 readOnly: true required: - display - id - name - prefix_count - slug - url - vlan_count WritableDeviceTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' default_platform: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPlatformRequest' nullable: true nullable: true model: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ part_number: type: string description: Discrete part number (optional) maxLength: 50 u_height: type: number format: double maximum: 1000 minimum: 0 exclusiveMaximum: true default: 1.0 title: Position (U) exclude_from_utilization: type: boolean description: Devices of this type are excluded when calculating rack utilization. is_full_depth: type: boolean description: Device consumes both front and rear rack faces. subdevice_role: enum: - parent - child - '' - null type: string x-spec-enum-id: 65a61d5e1deb4a24 nullable: true title: Parent/child status 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' airflow: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - rear-to-side - bottom-to-top - top-to-bottom - passive - mixed - '' - null type: string 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' x-spec-enum-id: 11cb3d363b41ba9e nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true front_image: type: string format: binary nullable: true rear_image: type: string format: binary nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - manufacturer - model - slug RackReservationRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: rack: oneOf: - type: integer - $ref: '#/components/schemas/BriefRackRequest' units: type: array items: type: integer maximum: 32767 minimum: 0 status: enum: - pending - active - stale type: string description: '* `pending` - Pending * `active` - Active * `stale` - Stale' x-spec-enum-id: ed6038a4deee151c user: oneOf: - type: integer - $ref: '#/components/schemas/BriefUserRequest' tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string minLength: 1 maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - description - rack - units - user WritableRackTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' model: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 form_factor: enum: - 2-post-frame - 4-post-frame - 4-post-cabinet - wall-frame - wall-frame-vertical - wall-cabinet - wall-cabinet-vertical type: string 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)' x-spec-enum-id: 8a902fde21d48841 width: enum: - 10 - 19 - 21 - 23 type: integer x-spec-enum-id: 9b322795f297a9c3 description: 'Rail-to-rail width * `10` - 10 inches * `19` - 19 inches * `21` - 21 inches * `23` - 23 inches' minimum: 0 maximum: 32767 u_height: type: integer maximum: 100 minimum: 1 title: Height (U) description: Height in rack units starting_unit: type: integer maximum: 32767 minimum: 1 description: Starting unit for rack desc_units: type: boolean title: Descending units description: Units are numbered top-to-bottom outer_width: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (width) outer_height: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (height) outer_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (depth) outer_unit: enum: - mm - in - '' - null type: string description: '* `mm` - Millimeters * `in` - Inches' x-spec-enum-id: 3d701848b66312c3 nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true max_weight: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Maximum load capacity for the rack weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true mounting_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails. owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - form_factor - manufacturer - model - slug PatchedWritableRearPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 front_ports: type: array items: $ref: '#/components/schemas/RearPortTemplateMappingRequest' description: type: string maxLength: 200 BriefSiteRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 description: Full name of the site maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug DeviceType: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true manufacturer: $ref: '#/components/schemas/BriefManufacturer' default_platform: allOf: - $ref: '#/components/schemas/BriefPlatform' nullable: true model: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ part_number: type: string description: Discrete part number (optional) maxLength: 50 u_height: type: number format: double maximum: 1000 minimum: 0 exclusiveMaximum: true default: 1.0 title: Position (U) exclude_from_utilization: type: boolean description: Devices of this type are excluded when calculating rack utilization. is_full_depth: type: boolean description: Device consumes both front and rear rack faces. subdevice_role: type: object properties: value: enum: - parent - child - '' - null type: string description: '* `parent` - Parent * `child` - Child' x-spec-enum-id: 65a61d5e1deb4a24 label: type: string enum: - Parent - Child nullable: true airflow: type: object properties: value: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - rear-to-side - bottom-to-top - top-to-bottom - passive - mixed - '' - null type: string 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' x-spec-enum-id: 11cb3d363b41ba9e label: type: string enum: - Front to rear - Rear to front - Left to right - Right to left - Side to rear - Rear to side - Bottom to top - Top to bottom - Passive - Mixed nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true weight_unit: type: object properties: value: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 label: type: string enum: - Kilograms - Grams - Pounds - Ounces nullable: true front_image: type: string format: uri nullable: true rear_image: type: string format: uri nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true device_count: type: integer readOnly: true console_port_template_count: type: integer readOnly: true console_server_port_template_count: type: integer readOnly: true power_port_template_count: type: integer readOnly: true power_outlet_template_count: type: integer readOnly: true interface_template_count: type: integer readOnly: true front_port_template_count: type: integer readOnly: true rear_port_template_count: type: integer readOnly: true device_bay_template_count: type: integer readOnly: true module_bay_template_count: type: integer readOnly: true inventory_item_template_count: type: integer readOnly: true required: - console_port_template_count - console_server_port_template_count - created - device_bay_template_count - device_count - display - display_url - front_port_template_count - id - interface_template_count - inventory_item_template_count - last_updated - manufacturer - model - module_bay_template_count - power_outlet_template_count - power_port_template_count - rear_port_template_count - slug - url PaginatedConsolePortList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ConsolePort' BriefSiteGroup: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 site_count: type: integer readOnly: true default: 0 _depth: type: integer readOnly: true title: ' depth' required: - _depth - display - id - name - site_count - slug - url PowerPanelRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: site: oneOf: - type: integer - $ref: '#/components/schemas/BriefSiteRequest' location: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefLocationRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - site PaginatedConsoleServerPortTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ConsoleServerPortTemplate' BriefModuleTypeProfileRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name WirelessLAN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true ssid: type: string maxLength: 32 description: type: string maxLength: 200 group: allOf: - $ref: '#/components/schemas/BriefWirelessLANGroup' nullable: true status: type: object properties: value: enum: - active - reserved - disabled - deprecated - '' type: string description: '* `active` - Active * `reserved` - Reserved * `disabled` - Disabled * `deprecated` - Deprecated' x-spec-enum-id: e5549d7370ce2e6c label: type: string enum: - Active - Reserved - Disabled - Deprecated vlan: allOf: - $ref: '#/components/schemas/BriefVLAN' nullable: true scope_type: type: string nullable: true scope_id: type: integer nullable: true scope: readOnly: true nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true auth_type: type: object properties: value: enum: - open - wep - wpa-personal - wpa-enterprise - '' type: string description: '* `open` - Open * `wep` - WEP * `wpa-personal` - WPA Personal (PSK) * `wpa-enterprise` - WPA Enterprise' x-spec-enum-id: e917c12aac765910 label: type: string enum: - Open - WEP - WPA Personal (PSK) - WPA Enterprise auth_cipher: type: object properties: value: enum: - auto - tkip - aes - '' type: string description: '* `auto` - Auto * `tkip` - TKIP * `aes` - AES' x-spec-enum-id: 42f867e89988bb0c label: type: string enum: - Auto - TKIP - AES auth_psk: type: string title: Pre-shared key maxLength: 64 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - scope - ssid - url ModuleBayTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 position: type: string description: Identifier to reference when renaming installed components maxLength: 30 description: type: string maxLength: 200 required: - name WritableInterfaceTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - virtual - bridge - lag - 100base-fx - 100base-lfx - 100base-tx - 100base-t1 - 1000base-bx10-d - 1000base-bx10-u - 1000base-cwdm - 1000base-cx - 1000base-dwdm - 1000base-ex - 1000base-lsx - 1000base-lx - 1000base-lx10 - 1000base-sx - 1000base-t - 1000base-tx - 1000base-zx - 2.5gbase-t - 5gbase-t - 10gbase-br-d - 10gbase-br-u - 10gbase-cu - 10gbase-cx4 - 10gbase-er - 10gbase-lr - 10gbase-lrm - 10gbase-lx4 - 10gbase-sr - 10gbase-t - 10gbase-zr - 25gbase-cr - 25gbase-er - 25gbase-lr - 25gbase-sr - 25gbase-t - 40gbase-cr4 - 40gbase-er4 - 40gbase-fr4 - 40gbase-lr4 - 40gbase-sr4 - 40gbase-sr4-bd - 50gbase-cr - 50gbase-er - 50gbase-fr - 50gbase-lr - 50gbase-sr - 100gbase-cr1 - 100gbase-cr2 - 100gbase-cr4 - 100gbase-cr10 - 100gbase-cwdm4 - 100gbase-dr - 100gbase-er4 - 100gbase-fr1 - 100gbase-lr1 - 100gbase-lr4 - 100gbase-sr1 - 100gbase-sr1.2 - 100gbase-sr2 - 100gbase-sr4 - 100gbase-sr10 - 100gbase-zr - 200gbase-cr2 - 200gbase-cr4 - 200gbase-dr4 - 200gbase-er4 - 200gbase-fr4 - 200gbase-lr4 - 200gbase-sr2 - 200gbase-sr4 - 200gbase-vr2 - 400gbase-cr4 - 400gbase-dr4 - 400gbase-er8 - 400gbase-fr4 - 400gbase-fr8 - 400gbase-lr4 - 400gbase-lr8 - 400gbase-sr4 - 400gbase-sr4_2 - 400gbase-sr8 - 400gbase-sr16 - 400gbase-vr4 - 400gbase-zr - 800gbase-cr8 - 800gbase-dr8 - 800gbase-sr8 - 800gbase-vr8 - 1.6tbase-cr8 - 1.6tbase-dr8 - 1.6tbase-dr8-2 - 100base-x-sfp - 1000base-x-gbic - 1000base-x-sfp - 2.5gbase-x-sfp - 10gbase-x-sfpp - 10gbase-x-xenpak - 10gbase-x-xfp - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 50gbase-x-sfp56 - 100gbase-x-cfp - 100gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cxp - 100gbase-x-cpak - 100gbase-x-dsfp - 100gbase-x-qsfp28 - 100gbase-x-qsfpdd - 100gbase-x-sfpdd - 200gbase-x-cfp2 - 200gbase-x-qsfp56 - 200gbase-x-qsfpdd - 400gbase-x-qsfp112 - 400gbase-x-qsfpdd - 400gbase-x-cdfp - 400gbase-x-cfp2 - 400gbase-x-cfp8 - 400gbase-x-osfp - 400gbase-x-osfp-rhs - 800gbase-x-osfp - 800gbase-x-qsfpdd - 1.6tbase-x-osfp1600 - 1.6tbase-x-osfp1600-rhs - 1.6tbase-x-qsfpdd1600 - 1000base-kx - 2.5gbase-kx - 5gbase-kr - 10gbase-kr - 10gbase-kx4 - 25gbase-kr - 40gbase-kr4 - 50gbase-kr - 100gbase-kp4 - 100gbase-kr2 - 100gbase-kr4 - 1.6tbase-kr8 - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - ieee802.11ay - ieee802.11be - ieee802.15.1 - ieee802.15.4 - other-wireless - gsm - cdma - lte - 4g - 5g - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 32gfc-sfpp - 64gfc-qsfpp - 64gfc-sfpdd - 64gfc-sfpp - 128gfc-qsfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - xdsl - docsis - moca - bpon - epon - 10g-epon - gpon - xg-pon - xgs-pon - ng-pon2 - 25g-pon - 50g-pon - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - cisco-stackwise-80 - cisco-stackwise-160 - cisco-stackwise-320 - cisco-stackwise-480 - cisco-stackwise-1t - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string description: '* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) * `100base-fx` - 100BASE-FX (10/100ME) * `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) * `100base-t1` - 100BASE-T1 (10/100ME) * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) * `1000base-cwdm` - 1000BASE-CWDM (1GE) * `1000base-cx` - 1000BASE-CX (1GE DAC) * `1000base-dwdm` - 1000BASE-DWDM (1GE) * `1000base-ex` - 1000BASE-EX (1GE) * `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) * `1000base-lx10` - 1000BASE-LX10/LH (1GE) * `1000base-sx` - 1000BASE-SX (1GE) * `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) * `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) * `10gbase-er` - 10GBASE-ER (10GE) * `10gbase-lr` - 10GBASE-LR (10GE) * `10gbase-lrm` - 10GBASE-LRM (10GE) * `10gbase-lx4` - 10GBASE-LX4 (10GE) * `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) * `10gbase-zr` - 10GBASE-ZR (10GE) * `25gbase-cr` - 25GBASE-CR (25GE DAC) * `25gbase-er` - 25GBASE-ER (25GE) * `25gbase-lr` - 25GBASE-LR (25GE) * `25gbase-sr` - 25GBASE-SR (25GE) * `25gbase-t` - 25GBASE-T (25GE) * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) * `40gbase-er4` - 40GBASE-ER4 (40GE) * `40gbase-fr4` - 40GBASE-FR4 (40GE) * `40gbase-lr4` - 40GBASE-LR4 (40GE) * `40gbase-sr4` - 40GBASE-SR4 (40GE) * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) * `50gbase-cr` - 50GBASE-CR (50GE DAC) * `50gbase-er` - 50GBASE-ER (50GE) * `50gbase-fr` - 50GBASE-FR (50GE) * `50gbase-lr` - 50GBASE-LR (50GE) * `50gbase-sr` - 50GBASE-SR (50GE) * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) * `100gbase-dr` - 100GBASE-DR (100GE) * `100gbase-er4` - 100GBASE-ER4 (100GE) * `100gbase-fr1` - 100GBASE-FR1 (100GE) * `100gbase-lr1` - 100GBASE-LR1 (100GE) * `100gbase-lr4` - 100GBASE-LR4 (100GE) * `100gbase-sr1` - 100GBASE-SR1 (100GE) * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) * `100gbase-sr2` - 100GBASE-SR2 (100GE) * `100gbase-sr4` - 100GBASE-SR4 (100GE) * `100gbase-sr10` - 100GBASE-SR10 (100GE) * `100gbase-zr` - 100GBASE-ZR (100GE) * `200gbase-cr2` - 200GBASE-CR2 (200GE) * `200gbase-cr4` - 200GBASE-CR4 (200GE) * `200gbase-dr4` - 200GBASE-DR4 (200GE) * `200gbase-er4` - 200GBASE-ER4 (200GE) * `200gbase-fr4` - 200GBASE-FR4 (200GE) * `200gbase-lr4` - 200GBASE-LR4 (200GE) * `200gbase-sr2` - 200GBASE-SR2 (200GE) * `200gbase-sr4` - 200GBASE-SR4 (200GE) * `200gbase-vr2` - 200GBASE-VR2 (200GE) * `400gbase-cr4` - 400GBASE-CR4 (400GE) * `400gbase-dr4` - 400GBASE-DR4 (400GE) * `400gbase-er8` - 400GBASE-ER8 (400GE) * `400gbase-fr4` - 400GBASE-FR4 (400GE) * `400gbase-fr8` - 400GBASE-FR8 (400GE) * `400gbase-lr4` - 400GBASE-LR4 (400GE) * `400gbase-lr8` - 400GBASE-LR8 (400GE) * `400gbase-sr4` - 400GBASE-SR4 (400GE) * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) * `400gbase-sr8` - 400GBASE-SR8 (400GE) * `400gbase-sr16` - 400GBASE-SR16 (400GE) * `400gbase-vr4` - 400GBASE-VR4 (400GE) * `400gbase-zr` - 400GBASE-ZR (400GE) * `800gbase-cr8` - 800GBASE-CR8 (800GE) * `800gbase-dr8` - 800GBASE-DR8 (800GE) * `800gbase-sr8` - 800GBASE-SR8 (800GE) * `800gbase-vr8` - 800GBASE-VR8 (800GE) * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) * `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) * `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) * `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) * `100gbase-x-sfpdd` - SFP-DD (100GE) * `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) * `400gbase-x-cdfp` - CDFP (400GE) * `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) * `400gbase-x-osfp` - OSFP (400GE) * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) * `800gbase-x-qsfpdd` - QSFP-DD (800GE) * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) * `10gbase-kr` - 10GBASE-KR (10GE) * `10gbase-kx4` - 10GBASE-KX4 (10GE) * `25gbase-kr` - 25GBASE-KR (25GE) * `40gbase-kr4` - 40GBASE-KR4 (40GE) * `50gbase-kr` - 50GBASE-KR (50GE) * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) * `ieee802.11ad` - IEEE 802.11ad (WiGig) * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) * `ieee802.11ay` - IEEE 802.11ay (WiGig) * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) * `gsm` - GSM * `cdma` - CDMA * `lte` - LTE * `4g` - 4G * `5g` - 5G * `sonet-oc3` - OC-3/STM-1 * `sonet-oc12` - OC-12/STM-4 * `sonet-oc48` - OC-48/STM-16 * `sonet-oc192` - OC-192/STM-64 * `sonet-oc768` - OC-768/STM-256 * `sonet-oc1920` - OC-1920/STM-640 * `sonet-oc3840` - OC-3840/STM-1234 * `1gfc-sfp` - SFP (1GFC) * `2gfc-sfp` - SFP (2GFC) * `4gfc-sfp` - SFP (4GFC) * `8gfc-sfpp` - SFP+ (8GFC) * `16gfc-sfpp` - SFP+ (16GFC) * `32gfc-sfp28` - SFP28 (32GFC) * `32gfc-sfpp` - SFP+ (32GFC) * `64gfc-qsfpp` - QSFP+ (64GFC) * `64gfc-sfpdd` - SFP-DD (64GFC) * `64gfc-sfpp` - SFP+ (64GFC) * `128gfc-qsfp28` - QSFP28 (128GFC) * `infiniband-sdr` - SDR (2 Gbps) * `infiniband-ddr` - DDR (4 Gbps) * `infiniband-qdr` - QDR (8 Gbps) * `infiniband-fdr10` - FDR10 (10 Gbps) * `infiniband-fdr` - FDR (13.5 Gbps) * `infiniband-edr` - EDR (25 Gbps) * `infiniband-hdr` - HDR (50 Gbps) * `infiniband-ndr` - NDR (100 Gbps) * `infiniband-xdr` - XDR (250 Gbps) * `t1` - T1 (1.544 Mbps) * `e1` - E1 (2.048 Mbps) * `t3` - T3 (45 Mbps) * `e3` - E3 (34 Mbps) * `xdsl` - xDSL * `docsis` - DOCSIS * `moca` - MoCA * `bpon` - BPON (622 Mbps / 155 Mbps) * `epon` - EPON (1 Gbps) * `10g-epon` - 10G-EPON (10 Gbps) * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) * `xgs-pon` - XGS-PON (10 Gbps) * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) * `25g-pon` - 25G-PON (25 Gbps) * `50g-pon` - 50G-PON (50 Gbps) * `cisco-stackwise` - Cisco StackWise * `cisco-stackwise-plus` - Cisco StackWise Plus * `cisco-flexstack` - Cisco FlexStack * `cisco-flexstack-plus` - Cisco FlexStack Plus * `cisco-stackwise-80` - Cisco StackWise-80 * `cisco-stackwise-160` - Cisco StackWise-160 * `cisco-stackwise-320` - Cisco StackWise-320 * `cisco-stackwise-480` - Cisco StackWise-480 * `cisco-stackwise-1t` - Cisco StackWise-1T * `juniper-vcp` - Juniper VCP * `extreme-summitstack` - Extreme SummitStack * `extreme-summitstack-128` - Extreme SummitStack-128 * `extreme-summitstack-256` - Extreme SummitStack-256 * `extreme-summitstack-512` - Extreme SummitStack-512 * `other` - Other' x-spec-enum-id: b067eb1f050c6ae9 enabled: type: boolean mgmt_only: type: boolean title: Management only description: type: string maxLength: 200 bridge: type: integer nullable: true title: Bridge interface poe_mode: enum: - pd - pse - '' - null type: string description: '* `pd` - PD * `pse` - PSE' x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true poe_type: enum: - type1-ieee802.3af - type2-ieee802.3at - type3-ieee802.3bt - type4-ieee802.3bt - passive-24v-2pair - passive-24v-4pair - passive-48v-2pair - passive-48v-4pair - '' - null type: string description: '* `type1-ieee802.3af` - 802.3af (Type 1) * `type2-ieee802.3at` - 802.3at (Type 2) * `type3-ieee802.3bt` - 802.3bt (Type 3) * `type4-ieee802.3bt` - 802.3bt (Type 4) * `passive-24v-2pair` - Passive 24V (2-pair) * `passive-24v-4pair` - Passive 24V (4-pair) * `passive-48v-2pair` - Passive 48V (2-pair) * `passive-48v-4pair` - Passive 48V (4-pair)' x-spec-enum-id: 5473d57885f237ab nullable: true rf_role: enum: - ap - station - '' - null type: string description: '* `ap` - Access point * `station` - Station' x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role required: - name - type DeviceBay: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' name: type: string maxLength: 64 label: type: string description: Physical label maxLength: 64 description: type: string maxLength: 200 installed_device: allOf: - $ref: '#/components/schemas/BriefDevice' nullable: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - device - display - display_url - id - last_updated - name - url PatchedModuleTypeProfileRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 schema: nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} Cable: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true type: enum: - cat3 - cat5 - cat5e - cat6 - cat6a - cat7 - cat7a - cat8 - mrj21-trunk - dac-active - dac-passive - coaxial - rg-6 - rg-8 - rg-11 - rg-59 - rg-62 - rg-213 - lmr-100 - lmr-200 - lmr-400 - mmf - mmf-om1 - mmf-om2 - mmf-om3 - mmf-om4 - mmf-om5 - smf - smf-os1 - smf-os2 - aoc - power - usb - '' - null type: string 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' x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true a_terminations: type: array items: $ref: '#/components/schemas/GenericObject' b_terminations: type: array items: $ref: '#/components/schemas/GenericObject' status: type: object properties: value: enum: - connected - planned - decommissioning type: string description: '* `connected` - Connected * `planned` - Planned * `decommissioning` - Decommissioning' x-spec-enum-id: 80d251a40f3a3144 label: type: string enum: - Connected - Planned - Decommissioning profile: type: object properties: value: enum: - single-1c1p - single-1c2p - single-1c4p - single-1c6p - single-1c8p - single-1c12p - single-1c16p - trunk-2c1p - trunk-2c2p - trunk-2c4p - trunk-2c4p-shuffle - trunk-2c6p - trunk-2c8p - trunk-2c12p - trunk-4c1p - trunk-4c2p - trunk-4c4p - trunk-4c4p-shuffle - trunk-4c6p - trunk-4c8p - trunk-8c4p - breakout-1c2p-2c1p - breakout-1c4p-4c1p - breakout-1c6p-6c1p - breakout-2c4p-8c1p-shuffle type: string 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)' x-spec-enum-id: f566e6df6572f5d0 label: type: string enum: - 1C1P - 1C2P - 1C4P - 1C6P - 1C8P - 1C12P - 1C16P - 2C1P trunk - 2C2P trunk - 2C4P trunk - 2C4P trunk (shuffle) - 2C6P trunk - 2C8P trunk - 2C12P trunk - 4C1P trunk - 4C2P trunk - 4C4P trunk - 4C4P trunk (shuffle) - 4C6P trunk - 4C8P trunk - 8C4P trunk - 1C2P:2C1P breakout - 1C4P:4C1P breakout - 1C6P:6C1P breakout - 2C4P:8C1P breakout (shuffle) tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true label: type: string maxLength: 100 color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 length: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true length_unit: type: object properties: value: enum: - km - m - cm - mi - ft - in - '' - null type: string description: '* `km` - Kilometers * `m` - Meters * `cm` - Centimeters * `mi` - Miles * `ft` - Feet * `in` - Inches' x-spec-enum-id: 6e7645525ba02462 label: type: string enum: - Kilometers - Meters - Centimeters - Miles - Feet - Inches nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - url BriefSiteGroupRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug BriefPlatform: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 device_count: type: integer readOnly: true default: 0 virtualmachine_count: type: integer readOnly: true default: 0 _depth: type: integer readOnly: true title: ' depth' required: - _depth - device_count - display - id - name - slug - url - virtualmachine_count PatchedWritableSiteGroupRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ parent: type: integer nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string PatchedManufacturerRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedDeviceRoleList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DeviceRole' ASNSite: type: object description: 'This serializer is meant for inclusion in ASNSerializer and is only used to avoid a circular import of SiteSerializer.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string description: Full name of the site maxLength: 100 description: type: string maxLength: 200 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ required: - display - id - name - slug - url BriefRack: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 device_count: type: integer format: int64 readOnly: true required: - device_count - display - id - name - url WritableModuleTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: profile: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeProfileRequest' nullable: true nullable: true manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' model: type: string minLength: 1 maxLength: 100 part_number: type: string description: Discrete part number (optional) maxLength: 50 airflow: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - passive - '' - null type: string 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' x-spec-enum-id: 5ad4e700c656b09d nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true description: type: string maxLength: 200 attributes: nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - manufacturer - model NestedWirelessLink: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true ssid: type: string maxLength: 32 required: - display - display_url - id - url ModuleBayRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 installed_module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true label: type: string description: Physical label maxLength: 64 position: type: string description: Identifier to reference when renaming installed components maxLength: 30 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name FrontPortTemplate: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device_type: allOf: - $ref: '#/components/schemas/BriefDeviceType' nullable: true module_type: allOf: - $ref: '#/components/schemas/BriefModuleType' nullable: true name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c label: type: string enum: - 8P8C - 8P6C - 8P4C - 8P2C - 6P6C - 6P4C - 6P2C - 4P4C - 4P2C - GG45 - TERA 4P - TERA 2P - TERA 1P - 110 Punch - BNC - F Connector - N Connector - MRJ21 - FC - FC/PC - FC/UPC - FC/APC - LC - LC/PC - LC/UPC - LC/APC - LSH - LSH/PC - LSH/UPC - LSH/APC - LX.5 - LX.5/PC - LX.5/UPC - LX.5/APC - MPO - MTRJ - SC - SC/PC - SC/UPC - SC/APC - ST - CS - SN - SMA 905 - SMA 906 - URM-P2 - URM-P4 - URM-P8 - Splice - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB Micro AB - Other color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 rear_ports: type: array items: $ref: '#/components/schemas/FrontPortTemplateMapping' description: type: string maxLength: 200 created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - id - last_updated - name - type - url BriefDeviceType: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true manufacturer: $ref: '#/components/schemas/BriefManufacturer' model: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 device_count: type: integer readOnly: true required: - device_count - display - id - manufacturer - model - slug - url ModuleType: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true profile: allOf: - $ref: '#/components/schemas/BriefModuleTypeProfile' nullable: true manufacturer: $ref: '#/components/schemas/BriefManufacturer' model: type: string maxLength: 100 part_number: type: string description: Discrete part number (optional) maxLength: 50 airflow: type: object properties: value: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - passive - '' - null type: string 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' x-spec-enum-id: 5ad4e700c656b09d label: type: string enum: - Front to rear - Rear to front - Left to right - Right to left - Side to rear - Passive nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true weight_unit: type: object properties: value: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 label: type: string enum: - Kilograms - Grams - Pounds - Ounces nullable: true description: type: string maxLength: 200 attributes: nullable: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true module_count: type: integer readOnly: true required: - created - display - display_url - id - last_updated - manufacturer - model - module_count - url RearPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 front_ports: type: array items: $ref: '#/components/schemas/RearPortMappingRequest' description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name - type WritablePowerOutletRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c5 - iec-60320-c7 - iec-60320-c13 - iec-60320-c15 - iec-60320-c17 - iec-60320-c19 - iec-60320-c21 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15r - nema-5-15r - nema-5-20r - nema-5-30r - nema-5-50r - nema-6-15r - nema-6-20r - nema-6-30r - nema-6-50r - nema-10-30r - nema-10-50r - nema-14-20r - nema-14-30r - nema-14-50r - nema-14-60r - nema-15-15r - nema-15-20r - nema-15-30r - nema-15-50r - nema-15-60r - nema-l1-15r - nema-l5-15r - nema-l5-20r - nema-l5-30r - nema-l5-50r - nema-l6-15r - nema-l6-20r - nema-l6-30r - nema-l6-50r - nema-l10-30r - nema-l14-20r - nema-l14-30r - nema-l14-50r - nema-l14-60r - nema-l15-20r - nema-l15-30r - nema-l15-50r - nema-l15-60r - nema-l21-20r - nema-l21-30r - nema-l22-20r - nema-l22-30r - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ita-e - ita-f - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - ita-multistandard - usb-a - usb-micro-b - usb-c - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - eaton-c39 - hdot-cx - saf-d-grid - neutrik-powercon-20a - neutrik-powercon-32a - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string x-spec-enum-id: db3e4eb2b93615f8 nullable: true description: 'Physical port type * `iec-60320-c5` - C5 * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 * `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15r` - NEMA 1-15R * `nema-5-15r` - NEMA 5-15R * `nema-5-20r` - NEMA 5-20R * `nema-5-30r` - NEMA 5-30R * `nema-5-50r` - NEMA 5-50R * `nema-6-15r` - NEMA 6-15R * `nema-6-20r` - NEMA 6-20R * `nema-6-30r` - NEMA 6-30R * `nema-6-50r` - NEMA 6-50R * `nema-10-30r` - NEMA 10-30R * `nema-10-50r` - NEMA 10-50R * `nema-14-20r` - NEMA 14-20R * `nema-14-30r` - NEMA 14-30R * `nema-14-50r` - NEMA 14-50R * `nema-14-60r` - NEMA 14-60R * `nema-15-15r` - NEMA 15-15R * `nema-15-20r` - NEMA 15-20R * `nema-15-30r` - NEMA 15-30R * `nema-15-50r` - NEMA 15-50R * `nema-15-60r` - NEMA 15-60R * `nema-l1-15r` - NEMA L1-15R * `nema-l5-15r` - NEMA L5-15R * `nema-l5-20r` - NEMA L5-20R * `nema-l5-30r` - NEMA L5-30R * `nema-l5-50r` - NEMA L5-50R * `nema-l6-15r` - NEMA L6-15R * `nema-l6-20r` - NEMA L6-20R * `nema-l6-30r` - NEMA L6-30R * `nema-l6-50r` - NEMA L6-50R * `nema-l10-30r` - NEMA L10-30R * `nema-l14-20r` - NEMA L14-20R * `nema-l14-30r` - NEMA L14-30R * `nema-l14-50r` - NEMA L14-50R * `nema-l14-60r` - NEMA L14-60R * `nema-l15-20r` - NEMA L15-20R * `nema-l15-30r` - NEMA L15-30R * `nema-l15-50r` - NEMA L15-50R * `nema-l15-60r` - NEMA L15-60R * `nema-l21-20r` - NEMA L21-20R * `nema-l21-30r` - NEMA L21-30R * `nema-l22-20r` - NEMA L22-20R * `nema-l22-30r` - NEMA L22-30R * `CS6360C` - CS6360C * `CS6364C` - CS6364C * `CS8164C` - CS8164C * `CS8264C` - CS8264C * `CS8364C` - CS8364C * `CS8464C` - CS8464C * `ita-e` - ITA Type E (CEE 7/5) * `ita-f` - ITA Type F (CEE 7/3) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `ita-multistandard` - ITA Multistandard * `usb-a` - USB Type A * `usb-micro-b` - USB Micro B * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 * `hdot-cx` - HDOT Cx * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20a` - Neutrik powerCON (20A) * `neutrik-powercon-32a` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' status: enum: - enabled - disabled - faulty type: string description: '* `enabled` - Enabled * `disabled` - Disabled * `faulty` - Faulty' x-spec-enum-id: d60dce16858f3c69 color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 power_port: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPowerPortRequest' nullable: true nullable: true feed_leg: enum: - A - B - C - '' - null type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: 'Phase (for three-phase feeds) * `A` - A * `B` - B * `C` - C' description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name PatchedInventoryItemRoleRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string minLength: 1 pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefVirtualChassisRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 64 master: allOf: - $ref: '#/components/schemas/NestedDeviceRequest' nullable: true description: type: string maxLength: 200 required: - name BriefMACAddressRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: mac_address: type: string minLength: 1 description: type: string maxLength: 200 required: - mac_address WritablePowerFeedRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: power_panel: oneOf: - type: integer - $ref: '#/components/schemas/BriefPowerPanelRequest' rack: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 100 status: enum: - offline - active - planned - failed type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `failed` - Failed' x-spec-enum-id: ec530572dc778583 type: enum: - primary - redundant type: string description: '* `primary` - Primary * `redundant` - Redundant' x-spec-enum-id: 093a164236819eb8 supply: enum: - ac - dc type: string description: '* `ac` - AC * `dc` - DC' x-spec-enum-id: 1b6d99616ca6412b phase: enum: - single-phase - three-phase type: string description: '* `single-phase` - Single phase * `three-phase` - Three-phase' x-spec-enum-id: 994bc0696f4df57f voltage: type: integer maximum: 32767 minimum: -32768 amperage: type: integer maximum: 32767 minimum: 1 max_utilization: type: integer maximum: 100 minimum: 1 description: Maximum permissible draw (percentage) mark_connected: type: boolean description: Treat as if a cable is connected description: type: string maxLength: 200 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - power_panel Platform: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true parent: allOf: - $ref: '#/components/schemas/NestedPlatform' nullable: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ manufacturer: allOf: - $ref: '#/components/schemas/BriefManufacturer' nullable: true config_template: allOf: - $ref: '#/components/schemas/BriefConfigTemplate' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true device_count: type: integer readOnly: true default: 0 virtualmachine_count: type: integer readOnly: true default: 0 _depth: type: integer readOnly: true title: ' depth' required: - _depth - created - device_count - display - display_url - id - last_updated - name - slug - url - virtualmachine_count NestedSiteGroupRequest: type: object 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.' properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ required: - name - slug BriefManufacturer: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - display - id - name - slug - url BriefRackRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name RegionRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ parent: allOf: - $ref: '#/components/schemas/NestedRegionRequest' nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string required: - name - slug LocationRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ site: oneOf: - type: integer - $ref: '#/components/schemas/BriefSiteRequest' parent: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true status: enum: - planned - staging - active - decommissioning - retired type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `retired` - Retired' x-spec-enum-id: 1cf60831fbb35e7f tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true facility: type: string description: Local facility ID or description maxLength: 50 description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string required: - name - site - slug PaginatedLocationList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Location' PatchedWritablePowerPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c6 - iec-60320-c8 - iec-60320-c14 - iec-60320-c16 - iec-60320-c18 - iec-60320-c20 - iec-60320-c22 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15p - nema-5-15p - nema-5-20p - nema-5-30p - nema-5-50p - nema-6-15p - nema-6-20p - nema-6-30p - nema-6-50p - nema-10-30p - nema-10-50p - nema-14-20p - nema-14-30p - nema-14-50p - nema-14-60p - nema-15-15p - nema-15-20p - nema-15-30p - nema-15-50p - nema-15-60p - nema-l1-15p - nema-l5-15p - nema-l5-20p - nema-l5-30p - nema-l5-50p - nema-l6-15p - nema-l6-20p - nema-l6-30p - nema-l6-50p - nema-l10-30p - nema-l14-20p - nema-l14-30p - nema-l14-50p - nema-l14-60p - nema-l15-20p - nema-l15-30p - nema-l15-50p - nema-l15-60p - nema-l21-20p - nema-l21-30p - nema-l22-20p - nema-l22-30p - cs6361c - cs6365c - cs8165c - cs8265c - cs8365c - cs8465c - ita-c - ita-e - ita-f - ita-ef - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - usb-3-b - usb-3-micro-b - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - saf-d-grid - neutrik-powercon-20 - neutrik-powercon-32 - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: 'Physical port type * `iec-60320-c6` - C6 * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 * `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15p` - NEMA 1-15P * `nema-5-15p` - NEMA 5-15P * `nema-5-20p` - NEMA 5-20P * `nema-5-30p` - NEMA 5-30P * `nema-5-50p` - NEMA 5-50P * `nema-6-15p` - NEMA 6-15P * `nema-6-20p` - NEMA 6-20P * `nema-6-30p` - NEMA 6-30P * `nema-6-50p` - NEMA 6-50P * `nema-10-30p` - NEMA 10-30P * `nema-10-50p` - NEMA 10-50P * `nema-14-20p` - NEMA 14-20P * `nema-14-30p` - NEMA 14-30P * `nema-14-50p` - NEMA 14-50P * `nema-14-60p` - NEMA 14-60P * `nema-15-15p` - NEMA 15-15P * `nema-15-20p` - NEMA 15-20P * `nema-15-30p` - NEMA 15-30P * `nema-15-50p` - NEMA 15-50P * `nema-15-60p` - NEMA 15-60P * `nema-l1-15p` - NEMA L1-15P * `nema-l5-15p` - NEMA L5-15P * `nema-l5-20p` - NEMA L5-20P * `nema-l5-30p` - NEMA L5-30P * `nema-l5-50p` - NEMA L5-50P * `nema-l6-15p` - NEMA L6-15P * `nema-l6-20p` - NEMA L6-20P * `nema-l6-30p` - NEMA L6-30P * `nema-l6-50p` - NEMA L6-50P * `nema-l10-30p` - NEMA L10-30P * `nema-l14-20p` - NEMA L14-20P * `nema-l14-30p` - NEMA L14-30P * `nema-l14-50p` - NEMA L14-50P * `nema-l14-60p` - NEMA L14-60P * `nema-l15-20p` - NEMA L15-20P * `nema-l15-30p` - NEMA L15-30P * `nema-l15-50p` - NEMA L15-50P * `nema-l15-60p` - NEMA L15-60P * `nema-l21-20p` - NEMA L21-20P * `nema-l21-30p` - NEMA L21-30P * `nema-l22-20p` - NEMA L22-20P * `nema-l22-30p` - NEMA L22-30P * `cs6361c` - CS6361C * `cs6365c` - CS6365C * `cs8165c` - CS8165C * `cs8265c` - CS8265C * `cs8365c` - CS8365C * `cs8465c` - CS8465C * `ita-c` - ITA Type C (CEE 7/16) * `ita-e` - ITA Type E (CEE 7/6) * `ita-f` - ITA Type F (CEE 7/4) * `ita-ef` - ITA Type E/F (CEE 7/7) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `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 * `usb-3-b` - USB 3.0 Type B * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20` - Neutrik powerCON (20A) * `neutrik-powercon-32` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' maximum_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Maximum power draw (watts) allocated_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Allocated power draw (watts) description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedInventoryItemTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/InventoryItemTemplate' InterfaceTemplate: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device_type: allOf: - $ref: '#/components/schemas/BriefDeviceType' nullable: true module_type: allOf: - $ref: '#/components/schemas/BriefModuleType' nullable: true name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - virtual - bridge - lag - 100base-fx - 100base-lfx - 100base-tx - 100base-t1 - 1000base-bx10-d - 1000base-bx10-u - 1000base-cwdm - 1000base-cx - 1000base-dwdm - 1000base-ex - 1000base-lsx - 1000base-lx - 1000base-lx10 - 1000base-sx - 1000base-t - 1000base-tx - 1000base-zx - 2.5gbase-t - 5gbase-t - 10gbase-br-d - 10gbase-br-u - 10gbase-cu - 10gbase-cx4 - 10gbase-er - 10gbase-lr - 10gbase-lrm - 10gbase-lx4 - 10gbase-sr - 10gbase-t - 10gbase-zr - 25gbase-cr - 25gbase-er - 25gbase-lr - 25gbase-sr - 25gbase-t - 40gbase-cr4 - 40gbase-er4 - 40gbase-fr4 - 40gbase-lr4 - 40gbase-sr4 - 40gbase-sr4-bd - 50gbase-cr - 50gbase-er - 50gbase-fr - 50gbase-lr - 50gbase-sr - 100gbase-cr1 - 100gbase-cr2 - 100gbase-cr4 - 100gbase-cr10 - 100gbase-cwdm4 - 100gbase-dr - 100gbase-er4 - 100gbase-fr1 - 100gbase-lr1 - 100gbase-lr4 - 100gbase-sr1 - 100gbase-sr1.2 - 100gbase-sr2 - 100gbase-sr4 - 100gbase-sr10 - 100gbase-zr - 200gbase-cr2 - 200gbase-cr4 - 200gbase-dr4 - 200gbase-er4 - 200gbase-fr4 - 200gbase-lr4 - 200gbase-sr2 - 200gbase-sr4 - 200gbase-vr2 - 400gbase-cr4 - 400gbase-dr4 - 400gbase-er8 - 400gbase-fr4 - 400gbase-fr8 - 400gbase-lr4 - 400gbase-lr8 - 400gbase-sr4 - 400gbase-sr4_2 - 400gbase-sr8 - 400gbase-sr16 - 400gbase-vr4 - 400gbase-zr - 800gbase-cr8 - 800gbase-dr8 - 800gbase-sr8 - 800gbase-vr8 - 1.6tbase-cr8 - 1.6tbase-dr8 - 1.6tbase-dr8-2 - 100base-x-sfp - 1000base-x-gbic - 1000base-x-sfp - 2.5gbase-x-sfp - 10gbase-x-sfpp - 10gbase-x-xenpak - 10gbase-x-xfp - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 50gbase-x-sfp56 - 100gbase-x-cfp - 100gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cxp - 100gbase-x-cpak - 100gbase-x-dsfp - 100gbase-x-qsfp28 - 100gbase-x-qsfpdd - 100gbase-x-sfpdd - 200gbase-x-cfp2 - 200gbase-x-qsfp56 - 200gbase-x-qsfpdd - 400gbase-x-qsfp112 - 400gbase-x-qsfpdd - 400gbase-x-cdfp - 400gbase-x-cfp2 - 400gbase-x-cfp8 - 400gbase-x-osfp - 400gbase-x-osfp-rhs - 800gbase-x-osfp - 800gbase-x-qsfpdd - 1.6tbase-x-osfp1600 - 1.6tbase-x-osfp1600-rhs - 1.6tbase-x-qsfpdd1600 - 1000base-kx - 2.5gbase-kx - 5gbase-kr - 10gbase-kr - 10gbase-kx4 - 25gbase-kr - 40gbase-kr4 - 50gbase-kr - 100gbase-kp4 - 100gbase-kr2 - 100gbase-kr4 - 1.6tbase-kr8 - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - ieee802.11ay - ieee802.11be - ieee802.15.1 - ieee802.15.4 - other-wireless - gsm - cdma - lte - 4g - 5g - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 32gfc-sfpp - 64gfc-qsfpp - 64gfc-sfpdd - 64gfc-sfpp - 128gfc-qsfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - xdsl - docsis - moca - bpon - epon - 10g-epon - gpon - xg-pon - xgs-pon - ng-pon2 - 25g-pon - 50g-pon - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - cisco-stackwise-80 - cisco-stackwise-160 - cisco-stackwise-320 - cisco-stackwise-480 - cisco-stackwise-1t - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string description: '* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) * `100base-fx` - 100BASE-FX (10/100ME) * `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) * `100base-t1` - 100BASE-T1 (10/100ME) * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) * `1000base-cwdm` - 1000BASE-CWDM (1GE) * `1000base-cx` - 1000BASE-CX (1GE DAC) * `1000base-dwdm` - 1000BASE-DWDM (1GE) * `1000base-ex` - 1000BASE-EX (1GE) * `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) * `1000base-lx10` - 1000BASE-LX10/LH (1GE) * `1000base-sx` - 1000BASE-SX (1GE) * `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) * `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) * `10gbase-er` - 10GBASE-ER (10GE) * `10gbase-lr` - 10GBASE-LR (10GE) * `10gbase-lrm` - 10GBASE-LRM (10GE) * `10gbase-lx4` - 10GBASE-LX4 (10GE) * `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) * `10gbase-zr` - 10GBASE-ZR (10GE) * `25gbase-cr` - 25GBASE-CR (25GE DAC) * `25gbase-er` - 25GBASE-ER (25GE) * `25gbase-lr` - 25GBASE-LR (25GE) * `25gbase-sr` - 25GBASE-SR (25GE) * `25gbase-t` - 25GBASE-T (25GE) * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) * `40gbase-er4` - 40GBASE-ER4 (40GE) * `40gbase-fr4` - 40GBASE-FR4 (40GE) * `40gbase-lr4` - 40GBASE-LR4 (40GE) * `40gbase-sr4` - 40GBASE-SR4 (40GE) * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) * `50gbase-cr` - 50GBASE-CR (50GE DAC) * `50gbase-er` - 50GBASE-ER (50GE) * `50gbase-fr` - 50GBASE-FR (50GE) * `50gbase-lr` - 50GBASE-LR (50GE) * `50gbase-sr` - 50GBASE-SR (50GE) * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) * `100gbase-dr` - 100GBASE-DR (100GE) * `100gbase-er4` - 100GBASE-ER4 (100GE) * `100gbase-fr1` - 100GBASE-FR1 (100GE) * `100gbase-lr1` - 100GBASE-LR1 (100GE) * `100gbase-lr4` - 100GBASE-LR4 (100GE) * `100gbase-sr1` - 100GBASE-SR1 (100GE) * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) * `100gbase-sr2` - 100GBASE-SR2 (100GE) * `100gbase-sr4` - 100GBASE-SR4 (100GE) * `100gbase-sr10` - 100GBASE-SR10 (100GE) * `100gbase-zr` - 100GBASE-ZR (100GE) * `200gbase-cr2` - 200GBASE-CR2 (200GE) * `200gbase-cr4` - 200GBASE-CR4 (200GE) * `200gbase-dr4` - 200GBASE-DR4 (200GE) * `200gbase-er4` - 200GBASE-ER4 (200GE) * `200gbase-fr4` - 200GBASE-FR4 (200GE) * `200gbase-lr4` - 200GBASE-LR4 (200GE) * `200gbase-sr2` - 200GBASE-SR2 (200GE) * `200gbase-sr4` - 200GBASE-SR4 (200GE) * `200gbase-vr2` - 200GBASE-VR2 (200GE) * `400gbase-cr4` - 400GBASE-CR4 (400GE) * `400gbase-dr4` - 400GBASE-DR4 (400GE) * `400gbase-er8` - 400GBASE-ER8 (400GE) * `400gbase-fr4` - 400GBASE-FR4 (400GE) * `400gbase-fr8` - 400GBASE-FR8 (400GE) * `400gbase-lr4` - 400GBASE-LR4 (400GE) * `400gbase-lr8` - 400GBASE-LR8 (400GE) * `400gbase-sr4` - 400GBASE-SR4 (400GE) * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) * `400gbase-sr8` - 400GBASE-SR8 (400GE) * `400gbase-sr16` - 400GBASE-SR16 (400GE) * `400gbase-vr4` - 400GBASE-VR4 (400GE) * `400gbase-zr` - 400GBASE-ZR (400GE) * `800gbase-cr8` - 800GBASE-CR8 (800GE) * `800gbase-dr8` - 800GBASE-DR8 (800GE) * `800gbase-sr8` - 800GBASE-SR8 (800GE) * `800gbase-vr8` - 800GBASE-VR8 (800GE) * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) * `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) * `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) * `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) * `100gbase-x-sfpdd` - SFP-DD (100GE) * `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) * `400gbase-x-cdfp` - CDFP (400GE) * `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) * `400gbase-x-osfp` - OSFP (400GE) * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) * `800gbase-x-qsfpdd` - QSFP-DD (800GE) * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) * `10gbase-kr` - 10GBASE-KR (10GE) * `10gbase-kx4` - 10GBASE-KX4 (10GE) * `25gbase-kr` - 25GBASE-KR (25GE) * `40gbase-kr4` - 40GBASE-KR4 (40GE) * `50gbase-kr` - 50GBASE-KR (50GE) * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) * `ieee802.11ad` - IEEE 802.11ad (WiGig) * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) * `ieee802.11ay` - IEEE 802.11ay (WiGig) * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) * `gsm` - GSM * `cdma` - CDMA * `lte` - LTE * `4g` - 4G * `5g` - 5G * `sonet-oc3` - OC-3/STM-1 * `sonet-oc12` - OC-12/STM-4 * `sonet-oc48` - OC-48/STM-16 * `sonet-oc192` - OC-192/STM-64 * `sonet-oc768` - OC-768/STM-256 * `sonet-oc1920` - OC-1920/STM-640 * `sonet-oc3840` - OC-3840/STM-1234 * `1gfc-sfp` - SFP (1GFC) * `2gfc-sfp` - SFP (2GFC) * `4gfc-sfp` - SFP (4GFC) * `8gfc-sfpp` - SFP+ (8GFC) * `16gfc-sfpp` - SFP+ (16GFC) * `32gfc-sfp28` - SFP28 (32GFC) * `32gfc-sfpp` - SFP+ (32GFC) * `64gfc-qsfpp` - QSFP+ (64GFC) * `64gfc-sfpdd` - SFP-DD (64GFC) * `64gfc-sfpp` - SFP+ (64GFC) * `128gfc-qsfp28` - QSFP28 (128GFC) * `infiniband-sdr` - SDR (2 Gbps) * `infiniband-ddr` - DDR (4 Gbps) * `infiniband-qdr` - QDR (8 Gbps) * `infiniband-fdr10` - FDR10 (10 Gbps) * `infiniband-fdr` - FDR (13.5 Gbps) * `infiniband-edr` - EDR (25 Gbps) * `infiniband-hdr` - HDR (50 Gbps) * `infiniband-ndr` - NDR (100 Gbps) * `infiniband-xdr` - XDR (250 Gbps) * `t1` - T1 (1.544 Mbps) * `e1` - E1 (2.048 Mbps) * `t3` - T3 (45 Mbps) * `e3` - E3 (34 Mbps) * `xdsl` - xDSL * `docsis` - DOCSIS * `moca` - MoCA * `bpon` - BPON (622 Mbps / 155 Mbps) * `epon` - EPON (1 Gbps) * `10g-epon` - 10G-EPON (10 Gbps) * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) * `xgs-pon` - XGS-PON (10 Gbps) * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) * `25g-pon` - 25G-PON (25 Gbps) * `50g-pon` - 50G-PON (50 Gbps) * `cisco-stackwise` - Cisco StackWise * `cisco-stackwise-plus` - Cisco StackWise Plus * `cisco-flexstack` - Cisco FlexStack * `cisco-flexstack-plus` - Cisco FlexStack Plus * `cisco-stackwise-80` - Cisco StackWise-80 * `cisco-stackwise-160` - Cisco StackWise-160 * `cisco-stackwise-320` - Cisco StackWise-320 * `cisco-stackwise-480` - Cisco StackWise-480 * `cisco-stackwise-1t` - Cisco StackWise-1T * `juniper-vcp` - Juniper VCP * `extreme-summitstack` - Extreme SummitStack * `extreme-summitstack-128` - Extreme SummitStack-128 * `extreme-summitstack-256` - Extreme SummitStack-256 * `extreme-summitstack-512` - Extreme SummitStack-512 * `other` - Other' x-spec-enum-id: b067eb1f050c6ae9 label: type: string enum: - Virtual - Bridge - Link Aggregation Group (LAG) - 100BASE-FX (10/100ME) - 100BASE-LFX (10/100ME) - 100BASE-TX (10/100ME) - 100BASE-T1 (10/100ME) - 1000BASE-BX10-D (1GE BiDi Down) - 1000BASE-BX10-U (1GE BiDi Up) - 1000BASE-CWDM (1GE) - 1000BASE-CX (1GE DAC) - 1000BASE-DWDM (1GE) - 1000BASE-EX (1GE) - 1000BASE-LSX (1GE) - 1000BASE-LX (1GE) - 1000BASE-LX10/LH (1GE) - 1000BASE-SX (1GE) - 1000BASE-T (1GE) - 1000BASE-TX (1GE) - 1000BASE-ZX (1GE) - 2.5GBASE-T (2.5GE) - 5GBASE-T (5GE) - 10GBASE-BR-D (10GE BiDi Down) - 10GBASE-BR-U (10GE BiDi Up) - 10GBASE-CU (10GE DAC Passive Twinax) - 10GBASE-CX4 (10GE DAC) - 10GBASE-ER (10GE) - 10GBASE-LR (10GE) - 10GBASE-LRM (10GE) - 10GBASE-LX4 (10GE) - 10GBASE-SR (10GE) - 10GBASE-T (10GE) - 10GBASE-ZR (10GE) - 25GBASE-CR (25GE DAC) - 25GBASE-ER (25GE) - 25GBASE-LR (25GE) - 25GBASE-SR (25GE) - 25GBASE-T (25GE) - 40GBASE-CR4 (40GE DAC) - 40GBASE-ER4 (40GE) - 40GBASE-FR4 (40GE) - 40GBASE-LR4 (40GE) - 40GBASE-SR4 (40GE) - 40GBASE-SR4 (40GE BiDi) - 50GBASE-CR (50GE DAC) - 50GBASE-ER (50GE) - 50GBASE-FR (50GE) - 50GBASE-LR (50GE) - 50GBASE-SR (50GE) - 100GBASE-CR1 (100GE DAC) - 100GBASE-CR2 (100GE DAC) - 100GBASE-CR4 (100GE DAC) - 100GBASE-CR10 (100GE DAC) - 100GBASE-CWDM4 (100GE) - 100GBASE-DR (100GE) - 100GBASE-ER4 (100GE) - 100GBASE-FR1 (100GE) - 100GBASE-LR1 (100GE) - 100GBASE-LR4 (100GE) - 100GBASE-SR1 (100GE) - 100GBASE-SR1.2 (100GE BiDi) - 100GBASE-SR2 (100GE) - 100GBASE-SR4 (100GE) - 100GBASE-SR10 (100GE) - 100GBASE-ZR (100GE) - 200GBASE-CR2 (200GE) - 200GBASE-CR4 (200GE) - 200GBASE-DR4 (200GE) - 200GBASE-ER4 (200GE) - 200GBASE-FR4 (200GE) - 200GBASE-LR4 (200GE) - 200GBASE-SR2 (200GE) - 200GBASE-SR4 (200GE) - 200GBASE-VR2 (200GE) - 400GBASE-CR4 (400GE) - 400GBASE-DR4 (400GE) - 400GBASE-ER8 (400GE) - 400GBASE-FR4 (400GE) - 400GBASE-FR8 (400GE) - 400GBASE-LR4 (400GE) - 400GBASE-LR8 (400GE) - 400GBASE-SR4 (400GE) - 400GBASE-SR4.2 (400GE BiDi) - 400GBASE-SR8 (400GE) - 400GBASE-SR16 (400GE) - 400GBASE-VR4 (400GE) - 400GBASE-ZR (400GE) - 800GBASE-CR8 (800GE) - 800GBASE-DR8 (800GE) - 800GBASE-SR8 (800GE) - 800GBASE-VR8 (800GE) - 1.6TBASE-CR8 (1.6TE) - 1.6TBASE-DR8 (1.6TE) - 1.6TBASE-DR8-2 (1.6TE) - SFP (100ME) - GBIC (1GE) - SFP (1GE) - SFP (2.5GE) - SFP+ (10GE) - XENPAK (10GE) - XFP (10GE) - X2 (10GE) - SFP28 (25GE) - QSFP+ (40GE) - QSFP28 (50GE) - SFP56 (50GE) - CFP (100GE) - CFP2 (100GE) - CFP4 (100GE) - CXP (100GE) - Cisco CPAK (100GE) - DSFP (100GE) - QSFP28 (100GE) - QSFP-DD (100GE) - SFP-DD (100GE) - CFP2 (200GE) - QSFP56 (200GE) - QSFP-DD (200GE) - QSFP112 (400GE) - QSFP-DD (400GE) - CDFP (400GE) - CFP2 (400GE) - CPF8 (400GE) - OSFP (400GE) - OSFP-RHS (400GE) - OSFP (800GE) - QSFP-DD (800GE) - OSFP1600 (1.6TE) - OSFP1600-RHS (1.6TE) - QSFP-DD1600 (1.6TE) - 1000BASE-KX (1GE) - 2.5GBASE-KX (2.5GE) - 5GBASE-KR (5GE) - 10GBASE-KR (10GE) - 10GBASE-KX4 (10GE) - 25GBASE-KR (25GE) - 40GBASE-KR4 (40GE) - 50GBASE-KR (50GE) - 100GBASE-KP4 (100GE) - 100GBASE-KR2 (100GE) - 100GBASE-KR4 (100GE) - 1.6TBASE-KR8 (1.6TE) - IEEE 802.11a - IEEE 802.11b/g - IEEE 802.11n (Wi-Fi 4) - IEEE 802.11ac (Wi-Fi 5) - IEEE 802.11ad (WiGig) - IEEE 802.11ax (Wi-Fi 6) - IEEE 802.11ay (WiGig) - IEEE 802.11be (Wi-Fi 7) - IEEE 802.15.1 (Bluetooth) - IEEE 802.15.4 (LR-WPAN) - Other (Wireless) - GSM - CDMA - LTE - 4G - 5G - OC-3/STM-1 - OC-12/STM-4 - OC-48/STM-16 - OC-192/STM-64 - OC-768/STM-256 - OC-1920/STM-640 - OC-3840/STM-1234 - SFP (1GFC) - SFP (2GFC) - SFP (4GFC) - SFP+ (8GFC) - SFP+ (16GFC) - SFP28 (32GFC) - SFP+ (32GFC) - QSFP+ (64GFC) - SFP-DD (64GFC) - SFP+ (64GFC) - QSFP28 (128GFC) - SDR (2 Gbps) - DDR (4 Gbps) - QDR (8 Gbps) - FDR10 (10 Gbps) - FDR (13.5 Gbps) - EDR (25 Gbps) - HDR (50 Gbps) - NDR (100 Gbps) - XDR (250 Gbps) - T1 (1.544 Mbps) - E1 (2.048 Mbps) - T3 (45 Mbps) - E3 (34 Mbps) - xDSL - DOCSIS - MoCA - BPON (622 Mbps / 155 Mbps) - EPON (1 Gbps) - 10G-EPON (10 Gbps) - GPON (2.5 Gbps / 1.25 Gbps) - XG-PON (10 Gbps / 2.5 Gbps) - XGS-PON (10 Gbps) - NG-PON2 (TWDM-PON) (4x10 Gbps) - 25G-PON (25 Gbps) - 50G-PON (50 Gbps) - Cisco StackWise - Cisco StackWise Plus - Cisco FlexStack - Cisco FlexStack Plus - Cisco StackWise-80 - Cisco StackWise-160 - Cisco StackWise-320 - Cisco StackWise-480 - Cisco StackWise-1T - Juniper VCP - Extreme SummitStack - Extreme SummitStack-128 - Extreme SummitStack-256 - Extreme SummitStack-512 - Other enabled: type: boolean mgmt_only: type: boolean title: Management only description: type: string maxLength: 200 bridge: allOf: - $ref: '#/components/schemas/NestedInterfaceTemplate' nullable: true poe_mode: type: object properties: value: enum: - pd - pse - '' - null type: string description: '* `pd` - PD * `pse` - PSE' x-spec-enum-id: 2f2fe6dcdc7772bd label: type: string enum: - PD - PSE nullable: true poe_type: type: object properties: value: enum: - type1-ieee802.3af - type2-ieee802.3at - type3-ieee802.3bt - type4-ieee802.3bt - passive-24v-2pair - passive-24v-4pair - passive-48v-2pair - passive-48v-4pair - '' - null type: string description: '* `type1-ieee802.3af` - 802.3af (Type 1) * `type2-ieee802.3at` - 802.3at (Type 2) * `type3-ieee802.3bt` - 802.3bt (Type 3) * `type4-ieee802.3bt` - 802.3bt (Type 4) * `passive-24v-2pair` - Passive 24V (2-pair) * `passive-24v-4pair` - Passive 24V (4-pair) * `passive-48v-2pair` - Passive 48V (2-pair) * `passive-48v-4pair` - Passive 48V (4-pair)' x-spec-enum-id: 5473d57885f237ab label: type: string enum: - 802.3af (Type 1) - 802.3at (Type 2) - 802.3bt (Type 3) - 802.3bt (Type 4) - Passive 24V (2-pair) - Passive 24V (4-pair) - Passive 48V (2-pair) - Passive 48V (4-pair) nullable: true rf_role: type: object properties: value: enum: - ap - station - '' - null type: string description: '* `ap` - Access point * `station` - Station' x-spec-enum-id: d2772dbea88b0fb1 label: type: string enum: - Access point - Station nullable: true created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - id - last_updated - name - type - url WritablePlatformRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: parent: type: integer nullable: true name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ manufacturer: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefManufacturerRequest' nullable: true nullable: true config_template: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefConfigTemplateRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug PowerPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c6 - iec-60320-c8 - iec-60320-c14 - iec-60320-c16 - iec-60320-c18 - iec-60320-c20 - iec-60320-c22 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15p - nema-5-15p - nema-5-20p - nema-5-30p - nema-5-50p - nema-6-15p - nema-6-20p - nema-6-30p - nema-6-50p - nema-10-30p - nema-10-50p - nema-14-20p - nema-14-30p - nema-14-50p - nema-14-60p - nema-15-15p - nema-15-20p - nema-15-30p - nema-15-50p - nema-15-60p - nema-l1-15p - nema-l5-15p - nema-l5-20p - nema-l5-30p - nema-l5-50p - nema-l6-15p - nema-l6-20p - nema-l6-30p - nema-l6-50p - nema-l10-30p - nema-l14-20p - nema-l14-30p - nema-l14-50p - nema-l14-60p - nema-l15-20p - nema-l15-30p - nema-l15-50p - nema-l15-60p - nema-l21-20p - nema-l21-30p - nema-l22-20p - nema-l22-30p - cs6361c - cs6365c - cs8165c - cs8265c - cs8365c - cs8465c - ita-c - ita-e - ita-f - ita-ef - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - usb-3-b - usb-3-micro-b - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - saf-d-grid - neutrik-powercon-20 - neutrik-powercon-32 - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c6` - C6 * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 * `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15p` - NEMA 1-15P * `nema-5-15p` - NEMA 5-15P * `nema-5-20p` - NEMA 5-20P * `nema-5-30p` - NEMA 5-30P * `nema-5-50p` - NEMA 5-50P * `nema-6-15p` - NEMA 6-15P * `nema-6-20p` - NEMA 6-20P * `nema-6-30p` - NEMA 6-30P * `nema-6-50p` - NEMA 6-50P * `nema-10-30p` - NEMA 10-30P * `nema-10-50p` - NEMA 10-50P * `nema-14-20p` - NEMA 14-20P * `nema-14-30p` - NEMA 14-30P * `nema-14-50p` - NEMA 14-50P * `nema-14-60p` - NEMA 14-60P * `nema-15-15p` - NEMA 15-15P * `nema-15-20p` - NEMA 15-20P * `nema-15-30p` - NEMA 15-30P * `nema-15-50p` - NEMA 15-50P * `nema-15-60p` - NEMA 15-60P * `nema-l1-15p` - NEMA L1-15P * `nema-l5-15p` - NEMA L5-15P * `nema-l5-20p` - NEMA L5-20P * `nema-l5-30p` - NEMA L5-30P * `nema-l5-50p` - NEMA L5-50P * `nema-l6-15p` - NEMA L6-15P * `nema-l6-20p` - NEMA L6-20P * `nema-l6-30p` - NEMA L6-30P * `nema-l6-50p` - NEMA L6-50P * `nema-l10-30p` - NEMA L10-30P * `nema-l14-20p` - NEMA L14-20P * `nema-l14-30p` - NEMA L14-30P * `nema-l14-50p` - NEMA L14-50P * `nema-l14-60p` - NEMA L14-60P * `nema-l15-20p` - NEMA L15-20P * `nema-l15-30p` - NEMA L15-30P * `nema-l15-50p` - NEMA L15-50P * `nema-l15-60p` - NEMA L15-60P * `nema-l21-20p` - NEMA L21-20P * `nema-l21-30p` - NEMA L21-30P * `nema-l22-20p` - NEMA L22-20P * `nema-l22-30p` - NEMA L22-30P * `cs6361c` - CS6361C * `cs6365c` - CS6365C * `cs8165c` - CS8165C * `cs8265c` - CS8265C * `cs8365c` - CS8365C * `cs8465c` - CS8465C * `ita-c` - ITA Type C (CEE 7/16) * `ita-e` - ITA Type E (CEE 7/6) * `ita-f` - ITA Type F (CEE 7/4) * `ita-ef` - ITA Type E/F (CEE 7/7) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `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 * `usb-3-b` - USB 3.0 Type B * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20` - Neutrik powerCON (20A) * `neutrik-powercon-32` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: aadcbe6ca854c1ed nullable: true maximum_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Maximum power draw (watts) allocated_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Allocated power draw (watts) description: type: string maxLength: 200 required: - name BriefModule: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' module_bay: $ref: '#/components/schemas/NestedModuleBay' required: - device - display - id - module_bay - url BriefInventoryItemRoleRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug WritableDeviceWithConfigContextRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string nullable: true maxLength: 64 device_type: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceTypeRequest' role: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRoleRequest' tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true platform: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPlatformRequest' nullable: true nullable: true serial: type: string title: Serial number description: Chassis serial number, assigned by the manufacturer maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this device maxLength: 50 site: oneOf: - type: integer - $ref: '#/components/schemas/BriefSiteRequest' location: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefLocationRequest' nullable: true nullable: true rack: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackRequest' nullable: true nullable: true position: type: number format: double maximum: 1000 minimum: 0.5 exclusiveMaximum: true nullable: true title: Position (U) face: enum: - front - rear - '' - null type: string description: '* `front` - Front * `rear` - Rear' x-spec-enum-id: d2fb9b3f75158b83 nullable: true title: Rack face latitude: type: number format: double maximum: 90.0 minimum: -90.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) longitude: type: number format: double maximum: 180.0 minimum: -180.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) status: enum: - offline - active - planned - staged - failed - inventory - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `inventory` - Inventory * `decommissioning` - Decommissioning' x-spec-enum-id: 65feb4244cc9110c airflow: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - rear-to-side - bottom-to-top - top-to-bottom - passive - mixed - '' - null type: string 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' x-spec-enum-id: 11cb3d363b41ba9e nullable: true primary_ip4: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true primary_ip6: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true oob_ip: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true cluster: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefClusterRequest' nullable: true nullable: true virtual_chassis: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVirtualChassisRequest' nullable: true nullable: true vc_position: type: integer maximum: 255 minimum: 0 nullable: true vc_priority: type: integer maximum: 255 minimum: 0 nullable: true description: Virtual chassis master election priority description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string config_template: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefConfigTemplateRequest' nullable: true nullable: true local_context_data: nullable: true description: Local config context data takes precedence over source contexts in the final rendered config context tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device_type - role - site PatchedWritableConsoleServerPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' - null type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: type: string maxLength: 200 PatchedWritableRackTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' model: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 form_factor: enum: - 2-post-frame - 4-post-frame - 4-post-cabinet - wall-frame - wall-frame-vertical - wall-cabinet - wall-cabinet-vertical type: string 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)' x-spec-enum-id: 8a902fde21d48841 width: enum: - 10 - 19 - 21 - 23 type: integer x-spec-enum-id: 9b322795f297a9c3 description: 'Rail-to-rail width * `10` - 10 inches * `19` - 19 inches * `21` - 21 inches * `23` - 23 inches' minimum: 0 maximum: 32767 u_height: type: integer maximum: 100 minimum: 1 title: Height (U) description: Height in rack units starting_unit: type: integer maximum: 32767 minimum: 1 description: Starting unit for rack desc_units: type: boolean title: Descending units description: Units are numbered top-to-bottom outer_width: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (width) outer_height: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (height) outer_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (depth) outer_unit: enum: - mm - in - '' - null type: string description: '* `mm` - Millimeters * `in` - Inches' x-spec-enum-id: 3d701848b66312c3 nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true max_weight: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Maximum load capacity for the rack weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true mounting_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails. owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} MACAddressRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: mac_address: type: string minLength: 1 assigned_object_type: type: string nullable: true assigned_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - mac_address RackTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' model: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 form_factor: enum: - 2-post-frame - 4-post-frame - 4-post-cabinet - wall-frame - wall-frame-vertical - wall-cabinet - wall-cabinet-vertical - '' - null type: string 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)' x-spec-enum-id: 8a902fde21d48841 nullable: true width: enum: - 10 - 19 - 21 - 23 type: integer description: '* `10` - 10 inches * `19` - 19 inches * `21` - 21 inches * `23` - 23 inches' x-spec-enum-id: 9b322795f297a9c3 u_height: type: integer maximum: 100 minimum: 1 title: Height (U) description: Height in rack units starting_unit: type: integer maximum: 32767 minimum: 1 description: Starting unit for rack desc_units: type: boolean title: Descending units description: Units are numbered top-to-bottom outer_width: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (width) outer_height: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (height) outer_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (depth) outer_unit: enum: - mm - in - '' - null type: string description: '* `mm` - Millimeters * `in` - Inches' x-spec-enum-id: 3d701848b66312c3 nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true max_weight: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Maximum load capacity for the rack weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true mounting_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails. owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - manufacturer - model - slug RearPortTemplate: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device_type: allOf: - $ref: '#/components/schemas/BriefDeviceType' nullable: true module_type: allOf: - $ref: '#/components/schemas/BriefModuleType' nullable: true name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c label: type: string enum: - 8P8C - 8P6C - 8P4C - 8P2C - 6P6C - 6P4C - 6P2C - 4P4C - 4P2C - GG45 - TERA 4P - TERA 2P - TERA 1P - 110 Punch - BNC - F Connector - N Connector - MRJ21 - FC - FC/PC - FC/UPC - FC/APC - LC - LC/PC - LC/UPC - LC/APC - LSH - LSH/PC - LSH/UPC - LSH/APC - LX.5 - LX.5/PC - LX.5/UPC - LX.5/APC - MPO - MTRJ - SC - SC/PC - SC/UPC - SC/APC - ST - CS - SN - SMA 905 - SMA 906 - URM-P2 - URM-P4 - URM-P8 - Splice - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB Micro AB - Other color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 front_ports: type: array items: $ref: '#/components/schemas/RearPortTemplateMapping' description: type: string maxLength: 200 created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - id - last_updated - name - type - url Rack: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 facility_id: type: string nullable: true maxLength: 50 site: $ref: '#/components/schemas/BriefSite' location: allOf: - $ref: '#/components/schemas/BriefLocation' nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true status: type: object properties: value: enum: - reserved - available - planned - active - deprecated type: string description: '* `reserved` - Reserved * `available` - Available * `planned` - Planned * `active` - Active * `deprecated` - Deprecated' x-spec-enum-id: 76eea4eef8804bcb label: type: string enum: - Reserved - Available - Planned - Active - Deprecated role: allOf: - $ref: '#/components/schemas/BriefRackRole' nullable: true serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this rack maxLength: 50 rack_type: allOf: - $ref: '#/components/schemas/BriefRackType' nullable: true form_factor: type: object properties: value: enum: - 2-post-frame - 4-post-frame - 4-post-cabinet - wall-frame - wall-frame-vertical - wall-cabinet - wall-cabinet-vertical - '' - null type: string 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)' x-spec-enum-id: 8a902fde21d48841 label: type: string enum: - 2-post frame - 4-post frame - 4-post cabinet - Wall-mounted frame - Wall-mounted frame (vertical) - Wall-mounted cabinet - Wall-mounted cabinet (vertical) nullable: true width: type: object properties: value: enum: - 10 - 19 - 21 - 23 type: integer description: '* `10` - 10 inches * `19` - 19 inches * `21` - 21 inches * `23` - 23 inches' x-spec-enum-id: 9b322795f297a9c3 label: type: string enum: - 10 inches - 19 inches - 21 inches - 23 inches u_height: type: integer maximum: 100 minimum: 1 title: Height (U) description: Height in rack units starting_unit: type: integer maximum: 32767 minimum: 1 description: Starting unit for rack weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true max_weight: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Maximum load capacity for the rack weight_unit: type: object properties: value: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 label: type: string enum: - Kilograms - Grams - Pounds - Ounces nullable: true desc_units: type: boolean title: Descending units description: Units are numbered top-to-bottom outer_width: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (width) outer_height: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (height) outer_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (depth) outer_unit: type: object properties: value: enum: - mm - in - '' - null type: string description: '* `mm` - Millimeters * `in` - Inches' x-spec-enum-id: 3d701848b66312c3 label: type: string enum: - Millimeters - Inches nullable: true mounting_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails. airflow: type: object properties: value: enum: - front-to-rear - rear-to-front - '' type: string description: '* `front-to-rear` - Front to rear * `rear-to-front` - Rear to front' x-spec-enum-id: a784734d07ef1b3c label: type: string enum: - Front to rear - Rear to front description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true device_count: type: integer format: int64 readOnly: true powerfeed_count: type: integer format: int64 readOnly: true required: - created - device_count - display - display_url - id - last_updated - name - powerfeed_count - site - url PatchedWritableConsolePortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' - null type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true 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' speed: enum: - 1200 - 2400 - 4800 - 9600 - 19200 - 38400 - 57600 - 115200 - null type: integer x-spec-enum-id: ab6d9635c131a378 nullable: true description: 'Port speed in bits per second * `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' minimum: 0 maximum: 2147483647 description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedManufacturerList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Manufacturer' NestedInterfaceTemplate: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 required: - display - id - name - url PatchedDeviceBayTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceTypeRequest' name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 description: type: string maxLength: 200 WritableRackReservationRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: rack: oneOf: - type: integer - $ref: '#/components/schemas/BriefRackRequest' units: type: array items: type: integer maximum: 32767 minimum: 0 status: enum: - pending - active - stale type: string description: '* `pending` - Pending * `active` - Active * `stale` - Stale' x-spec-enum-id: ed6038a4deee151c user: oneOf: - type: integer - $ref: '#/components/schemas/BriefUserRequest' tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string minLength: 1 maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - description - rack - units - user ConsolePort: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' module: allOf: - $ref: '#/components/schemas/BriefModule' nullable: true name: type: string maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 label: type: string enum: - DE-9 - DB-25 - RJ-11 - RJ-12 - RJ-45 - Mini-DIN 8 - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB Micro AB - Other speed: type: object properties: value: enum: - 1200 - 2400 - 4800 - 9600 - 19200 - 38400 - 57600 - 115200 - null type: integer description: '* `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' x-spec-enum-id: ab6d9635c131a378 label: type: string enum: - 1200 bps - 2400 bps - 4800 bps - 9600 bps - 19.2 kbps - 38.4 kbps - 57.6 kbps - 115.2 kbps nullable: true description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected cable: allOf: - $ref: '#/components/schemas/BriefCable' readOnly: true nullable: true cable_end: type: string readOnly: true link_peers: type: array items: {} readOnly: true link_peers_type: type: string description: Return the type of the peer link terminations, or None. readOnly: true nullable: true connected_endpoints: type: array items: {} nullable: true readOnly: true connected_endpoints_type: type: string readOnly: true nullable: true connected_endpoints_reachable: type: boolean readOnly: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - cable - cable_end - connected_endpoints - connected_endpoints_reachable - connected_endpoints_type - created - device - display - display_url - id - last_updated - link_peers - link_peers_type - name - url ModuleBay: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' module: allOf: - $ref: '#/components/schemas/BriefModule' nullable: true name: type: string maxLength: 64 installed_module: allOf: - $ref: '#/components/schemas/BriefModule' nullable: true label: type: string description: Physical label maxLength: 64 position: type: string description: Identifier to reference when renaming installed components maxLength: 30 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - device - display - display_url - id - last_updated - name - url BriefVLANGroup: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 vlan_count: type: integer format: int64 readOnly: true required: - display - id - name - slug - url - vlan_count PatchedWritablePlatformRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: parent: type: integer nullable: true name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ manufacturer: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefManufacturerRequest' nullable: true nullable: true config_template: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefConfigTemplateRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefCluster: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 virtualmachine_count: type: integer format: int64 readOnly: true required: - display - id - name - url - virtualmachine_count PatchedWritablePowerPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c6 - iec-60320-c8 - iec-60320-c14 - iec-60320-c16 - iec-60320-c18 - iec-60320-c20 - iec-60320-c22 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15p - nema-5-15p - nema-5-20p - nema-5-30p - nema-5-50p - nema-6-15p - nema-6-20p - nema-6-30p - nema-6-50p - nema-10-30p - nema-10-50p - nema-14-20p - nema-14-30p - nema-14-50p - nema-14-60p - nema-15-15p - nema-15-20p - nema-15-30p - nema-15-50p - nema-15-60p - nema-l1-15p - nema-l5-15p - nema-l5-20p - nema-l5-30p - nema-l5-50p - nema-l6-15p - nema-l6-20p - nema-l6-30p - nema-l6-50p - nema-l10-30p - nema-l14-20p - nema-l14-30p - nema-l14-50p - nema-l14-60p - nema-l15-20p - nema-l15-30p - nema-l15-50p - nema-l15-60p - nema-l21-20p - nema-l21-30p - nema-l22-20p - nema-l22-30p - cs6361c - cs6365c - cs8165c - cs8265c - cs8365c - cs8465c - ita-c - ita-e - ita-f - ita-ef - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - usb-3-b - usb-3-micro-b - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - saf-d-grid - neutrik-powercon-20 - neutrik-powercon-32 - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c6` - C6 * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 * `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15p` - NEMA 1-15P * `nema-5-15p` - NEMA 5-15P * `nema-5-20p` - NEMA 5-20P * `nema-5-30p` - NEMA 5-30P * `nema-5-50p` - NEMA 5-50P * `nema-6-15p` - NEMA 6-15P * `nema-6-20p` - NEMA 6-20P * `nema-6-30p` - NEMA 6-30P * `nema-6-50p` - NEMA 6-50P * `nema-10-30p` - NEMA 10-30P * `nema-10-50p` - NEMA 10-50P * `nema-14-20p` - NEMA 14-20P * `nema-14-30p` - NEMA 14-30P * `nema-14-50p` - NEMA 14-50P * `nema-14-60p` - NEMA 14-60P * `nema-15-15p` - NEMA 15-15P * `nema-15-20p` - NEMA 15-20P * `nema-15-30p` - NEMA 15-30P * `nema-15-50p` - NEMA 15-50P * `nema-15-60p` - NEMA 15-60P * `nema-l1-15p` - NEMA L1-15P * `nema-l5-15p` - NEMA L5-15P * `nema-l5-20p` - NEMA L5-20P * `nema-l5-30p` - NEMA L5-30P * `nema-l5-50p` - NEMA L5-50P * `nema-l6-15p` - NEMA L6-15P * `nema-l6-20p` - NEMA L6-20P * `nema-l6-30p` - NEMA L6-30P * `nema-l6-50p` - NEMA L6-50P * `nema-l10-30p` - NEMA L10-30P * `nema-l14-20p` - NEMA L14-20P * `nema-l14-30p` - NEMA L14-30P * `nema-l14-50p` - NEMA L14-50P * `nema-l14-60p` - NEMA L14-60P * `nema-l15-20p` - NEMA L15-20P * `nema-l15-30p` - NEMA L15-30P * `nema-l15-50p` - NEMA L15-50P * `nema-l15-60p` - NEMA L15-60P * `nema-l21-20p` - NEMA L21-20P * `nema-l21-30p` - NEMA L21-30P * `nema-l22-20p` - NEMA L22-20P * `nema-l22-30p` - NEMA L22-30P * `cs6361c` - CS6361C * `cs6365c` - CS6365C * `cs8165c` - CS8165C * `cs8265c` - CS8265C * `cs8365c` - CS8365C * `cs8465c` - CS8465C * `ita-c` - ITA Type C (CEE 7/16) * `ita-e` - ITA Type E (CEE 7/6) * `ita-f` - ITA Type F (CEE 7/4) * `ita-ef` - ITA Type E/F (CEE 7/7) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `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 * `usb-3-b` - USB 3.0 Type B * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20` - Neutrik powerCON (20A) * `neutrik-powercon-32` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: aadcbe6ca854c1ed nullable: true maximum_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Maximum power draw (watts) allocated_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Allocated power draw (watts) description: type: string maxLength: 200 PatchedWritablePowerFeedRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: power_panel: oneOf: - type: integer - $ref: '#/components/schemas/BriefPowerPanelRequest' rack: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 100 status: enum: - offline - active - planned - failed type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `failed` - Failed' x-spec-enum-id: ec530572dc778583 type: enum: - primary - redundant type: string description: '* `primary` - Primary * `redundant` - Redundant' x-spec-enum-id: 093a164236819eb8 supply: enum: - ac - dc type: string description: '* `ac` - AC * `dc` - DC' x-spec-enum-id: 1b6d99616ca6412b phase: enum: - single-phase - three-phase type: string description: '* `single-phase` - Single phase * `three-phase` - Three-phase' x-spec-enum-id: 994bc0696f4df57f voltage: type: integer maximum: 32767 minimum: -32768 amperage: type: integer maximum: 32767 minimum: 1 max_utilization: type: integer maximum: 100 minimum: 1 description: Maximum permissible draw (percentage) mark_connected: type: boolean description: Treat as if a cable is connected description: type: string maxLength: 200 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PatchedWritableSiteRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 description: Full name of the site maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ status: enum: - planned - staging - active - decommissioning - retired type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `retired` - Retired' x-spec-enum-id: 1cf60831fbb35e7f region: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRegionRequest' nullable: true nullable: true group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefSiteGroupRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true facility: type: string description: Local facility ID or description maxLength: 50 time_zone: type: string nullable: true minLength: 1 description: type: string maxLength: 200 physical_address: type: string description: Physical location of the building maxLength: 200 shipping_address: type: string description: If different from the physical address maxLength: 200 latitude: type: number format: double maximum: 90.0 minimum: -90.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) longitude: type: number format: double maximum: 180.0 minimum: -180.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string asns: type: array items: type: integer tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefModuleType: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true profile: allOf: - $ref: '#/components/schemas/BriefModuleTypeProfile' nullable: true manufacturer: $ref: '#/components/schemas/BriefManufacturer' model: type: string maxLength: 100 description: type: string maxLength: 200 module_count: type: integer readOnly: true required: - display - id - manufacturer - model - module_count - url BriefOwnerRequest: type: object 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)' properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name WritableConsolePortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' - null type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true 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' speed: enum: - 1200 - 2400 - 4800 - 9600 - 19200 - 38400 - 57600 - 115200 - null type: integer x-spec-enum-id: ab6d9635c131a378 nullable: true description: 'Port speed in bits per second * `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' minimum: 0 maximum: 2147483647 description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name WritablePowerPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c6 - iec-60320-c8 - iec-60320-c14 - iec-60320-c16 - iec-60320-c18 - iec-60320-c20 - iec-60320-c22 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15p - nema-5-15p - nema-5-20p - nema-5-30p - nema-5-50p - nema-6-15p - nema-6-20p - nema-6-30p - nema-6-50p - nema-10-30p - nema-10-50p - nema-14-20p - nema-14-30p - nema-14-50p - nema-14-60p - nema-15-15p - nema-15-20p - nema-15-30p - nema-15-50p - nema-15-60p - nema-l1-15p - nema-l5-15p - nema-l5-20p - nema-l5-30p - nema-l5-50p - nema-l6-15p - nema-l6-20p - nema-l6-30p - nema-l6-50p - nema-l10-30p - nema-l14-20p - nema-l14-30p - nema-l14-50p - nema-l14-60p - nema-l15-20p - nema-l15-30p - nema-l15-50p - nema-l15-60p - nema-l21-20p - nema-l21-30p - nema-l22-20p - nema-l22-30p - cs6361c - cs6365c - cs8165c - cs8265c - cs8365c - cs8465c - ita-c - ita-e - ita-f - ita-ef - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - usb-3-b - usb-3-micro-b - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - saf-d-grid - neutrik-powercon-20 - neutrik-powercon-32 - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string x-spec-enum-id: aadcbe6ca854c1ed nullable: true description: 'Physical port type * `iec-60320-c6` - C6 * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 * `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15p` - NEMA 1-15P * `nema-5-15p` - NEMA 5-15P * `nema-5-20p` - NEMA 5-20P * `nema-5-30p` - NEMA 5-30P * `nema-5-50p` - NEMA 5-50P * `nema-6-15p` - NEMA 6-15P * `nema-6-20p` - NEMA 6-20P * `nema-6-30p` - NEMA 6-30P * `nema-6-50p` - NEMA 6-50P * `nema-10-30p` - NEMA 10-30P * `nema-10-50p` - NEMA 10-50P * `nema-14-20p` - NEMA 14-20P * `nema-14-30p` - NEMA 14-30P * `nema-14-50p` - NEMA 14-50P * `nema-14-60p` - NEMA 14-60P * `nema-15-15p` - NEMA 15-15P * `nema-15-20p` - NEMA 15-20P * `nema-15-30p` - NEMA 15-30P * `nema-15-50p` - NEMA 15-50P * `nema-15-60p` - NEMA 15-60P * `nema-l1-15p` - NEMA L1-15P * `nema-l5-15p` - NEMA L5-15P * `nema-l5-20p` - NEMA L5-20P * `nema-l5-30p` - NEMA L5-30P * `nema-l5-50p` - NEMA L5-50P * `nema-l6-15p` - NEMA L6-15P * `nema-l6-20p` - NEMA L6-20P * `nema-l6-30p` - NEMA L6-30P * `nema-l6-50p` - NEMA L6-50P * `nema-l10-30p` - NEMA L10-30P * `nema-l14-20p` - NEMA L14-20P * `nema-l14-30p` - NEMA L14-30P * `nema-l14-50p` - NEMA L14-50P * `nema-l14-60p` - NEMA L14-60P * `nema-l15-20p` - NEMA L15-20P * `nema-l15-30p` - NEMA L15-30P * `nema-l15-50p` - NEMA L15-50P * `nema-l15-60p` - NEMA L15-60P * `nema-l21-20p` - NEMA L21-20P * `nema-l21-30p` - NEMA L21-30P * `nema-l22-20p` - NEMA L22-20P * `nema-l22-30p` - NEMA L22-30P * `cs6361c` - CS6361C * `cs6365c` - CS6365C * `cs8165c` - CS8165C * `cs8265c` - CS8265C * `cs8365c` - CS8365C * `cs8465c` - CS8465C * `ita-c` - ITA Type C (CEE 7/16) * `ita-e` - ITA Type E (CEE 7/6) * `ita-f` - ITA Type F (CEE 7/4) * `ita-ef` - ITA Type E/F (CEE 7/7) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `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 * `usb-3-b` - USB 3.0 Type B * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20` - Neutrik powerCON (20A) * `neutrik-powercon-32` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' maximum_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Maximum power draw (watts) allocated_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Allocated power draw (watts) description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name BriefVLAN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string maxLength: 64 description: type: string maxLength: 200 required: - display - id - name - url - vid PatchedWritableFrontPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 rear_ports: type: array items: $ref: '#/components/schemas/FrontPortTemplateMappingRequest' description: type: string maxLength: 200 PaginatedInventoryItemRoleList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/InventoryItemRole' RackRoleRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string minLength: 1 pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug PaginatedDeviceTypeList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DeviceType' BriefDeviceRole: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 device_count: type: integer readOnly: true default: 0 virtualmachine_count: type: integer readOnly: true default: 0 _depth: type: integer readOnly: true title: ' depth' required: - _depth - device_count - display - id - name - slug - url - virtualmachine_count BriefPowerPanel: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 powerfeed_count: type: integer format: int64 readOnly: true required: - display - id - name - powerfeed_count - url ManufacturerRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug ConsolePortTemplate: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device_type: allOf: - $ref: '#/components/schemas/BriefDeviceType' nullable: true module_type: allOf: - $ref: '#/components/schemas/BriefModuleType' nullable: true name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 label: type: string enum: - DE-9 - DB-25 - RJ-11 - RJ-12 - RJ-45 - Mini-DIN 8 - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB Micro AB - Other description: type: string maxLength: 200 created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - id - last_updated - name - url RearPortMapping: type: object properties: position: type: integer front_port: type: integer front_port_position: type: integer maximum: 1024 minimum: 1 default: 1 required: - front_port - position BriefL2VPN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true identifier: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: type: object properties: value: enum: - vpws - vpls - vxlan - vxlan-evpn - mpls-evpn - pbb-evpn - evpn-vpws - epl - evpl - ep-lan - evp-lan - ep-tree - evp-tree - spb type: string 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' x-spec-enum-id: 0a46f8056d717efc label: type: string enum: - VPWS - VPLS - VXLAN - VXLAN-EVPN - MPLS EVPN - PBB EVPN - EVPN VPWS - EPL - EVPL - Ethernet Private LAN - Ethernet Virtual Private LAN - Ethernet Private Tree - Ethernet Virtual Private Tree - SPB description: type: string maxLength: 200 required: - display - id - name - slug - url PaginatedConsolePortTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ConsolePortTemplate' PatchedWritableDeviceTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' default_platform: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPlatformRequest' nullable: true nullable: true model: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ part_number: type: string description: Discrete part number (optional) maxLength: 50 u_height: type: number format: double maximum: 1000 minimum: 0 exclusiveMaximum: true default: 1.0 title: Position (U) exclude_from_utilization: type: boolean description: Devices of this type are excluded when calculating rack utilization. is_full_depth: type: boolean description: Device consumes both front and rear rack faces. subdevice_role: enum: - parent - child - '' - null type: string x-spec-enum-id: 65a61d5e1deb4a24 nullable: true title: Parent/child status 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' airflow: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - rear-to-side - bottom-to-top - top-to-bottom - passive - mixed - '' - null type: string 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' x-spec-enum-id: 11cb3d363b41ba9e nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true front_image: type: string format: binary nullable: true rear_image: type: string format: binary nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefPowerPortTemplate: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 description: type: string maxLength: 200 required: - display - id - name - url PaginatedConsoleServerPortList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ConsoleServerPort' InventoryItemTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceTypeRequest' parent: type: integer nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefInventoryItemRoleRequest' nullable: true nullable: true manufacturer: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefManufacturerRequest' nullable: true nullable: true part_id: type: string description: Manufacturer-assigned part identifier maxLength: 50 description: type: string maxLength: 200 component_type: type: string nullable: true component_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true required: - device_type - name PatchedWritableModuleRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module_bay: type: integer module_type: oneOf: - type: integer - $ref: '#/components/schemas/BriefModuleTypeRequest' status: enum: - offline - active - planned - staged - failed - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning' x-spec-enum-id: 545817eb4c4f2ae4 serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this device maxLength: 50 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} NestedVLAN: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string maxLength: 64 description: type: string maxLength: 200 required: - display - id - name - url - vid VirtualDeviceContext: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 64 device: $ref: '#/components/schemas/BriefDevice' identifier: type: integer maximum: 32767 minimum: 0 nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true primary_ip: allOf: - $ref: '#/components/schemas/BriefIPAddress' readOnly: true nullable: true primary_ip4: allOf: - $ref: '#/components/schemas/BriefIPAddress' nullable: true primary_ip6: allOf: - $ref: '#/components/schemas/BriefIPAddress' nullable: true status: type: object properties: value: enum: - active - planned - offline type: string description: '* `active` - Active * `planned` - Planned * `offline` - Offline' x-spec-enum-id: 0e2c0919d51b83cb label: type: string enum: - Active - Planned - Offline description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true interface_count: type: integer format: int64 readOnly: true required: - created - device - display - display_url - id - interface_count - last_updated - name - primary_ip - status - url PatchedWritableVirtualChassisRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 64 domain: type: string maxLength: 30 master: type: integer nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefVLANTranslationPolicyRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name PaginatedRackTypeList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/RackType' MACAddress: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true mac_address: type: string assigned_object_type: type: string nullable: true assigned_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true assigned_object: readOnly: true nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - assigned_object - created - display - display_url - id - last_updated - mac_address - url PaginatedRackRoleList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/RackRole' PatchedWritableDeviceWithConfigContextRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string nullable: true maxLength: 64 device_type: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceTypeRequest' role: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRoleRequest' tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true platform: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPlatformRequest' nullable: true nullable: true serial: type: string title: Serial number description: Chassis serial number, assigned by the manufacturer maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this device maxLength: 50 site: oneOf: - type: integer - $ref: '#/components/schemas/BriefSiteRequest' location: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefLocationRequest' nullable: true nullable: true rack: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackRequest' nullable: true nullable: true position: type: number format: double maximum: 1000 minimum: 0.5 exclusiveMaximum: true nullable: true title: Position (U) face: enum: - front - rear - '' - null type: string description: '* `front` - Front * `rear` - Rear' x-spec-enum-id: d2fb9b3f75158b83 nullable: true title: Rack face latitude: type: number format: double maximum: 90.0 minimum: -90.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) longitude: type: number format: double maximum: 180.0 minimum: -180.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) status: enum: - offline - active - planned - staged - failed - inventory - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `inventory` - Inventory * `decommissioning` - Decommissioning' x-spec-enum-id: 65feb4244cc9110c airflow: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - rear-to-side - bottom-to-top - top-to-bottom - passive - mixed - '' - null type: string 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' x-spec-enum-id: 11cb3d363b41ba9e nullable: true primary_ip4: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true primary_ip6: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true oob_ip: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true cluster: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefClusterRequest' nullable: true nullable: true virtual_chassis: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVirtualChassisRequest' nullable: true nullable: true vc_position: type: integer maximum: 255 minimum: 0 nullable: true vc_priority: type: integer maximum: 255 minimum: 0 nullable: true description: Virtual chassis master election priority description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string config_template: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefConfigTemplateRequest' nullable: true nullable: true local_context_data: nullable: true description: Local config context data takes precedence over source contexts in the final rendered config context tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} Manufacturer: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true devicetype_count: type: integer format: int64 readOnly: true moduletype_count: type: integer format: int64 readOnly: true inventoryitem_count: type: integer format: int64 readOnly: true platform_count: type: integer format: int64 readOnly: true required: - created - devicetype_count - display - display_url - id - inventoryitem_count - last_updated - moduletype_count - name - platform_count - slug - url Site: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string description: Full name of the site maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ status: type: object properties: value: enum: - planned - staging - active - decommissioning - retired type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `retired` - Retired' x-spec-enum-id: 1cf60831fbb35e7f label: type: string enum: - Planned - Staging - Active - Decommissioning - Retired region: allOf: - $ref: '#/components/schemas/BriefRegion' nullable: true group: allOf: - $ref: '#/components/schemas/BriefSiteGroup' nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true facility: type: string description: Local facility ID or description maxLength: 50 time_zone: type: string nullable: true description: type: string maxLength: 200 physical_address: type: string description: Physical location of the building maxLength: 200 shipping_address: type: string description: If different from the physical address maxLength: 200 latitude: type: number format: double maximum: 90.0 minimum: -90.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) longitude: type: number format: double maximum: 180.0 minimum: -180.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string asns: type: array items: $ref: '#/components/schemas/ASN' tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true circuit_count: type: integer format: int64 readOnly: true device_count: type: integer format: int64 readOnly: true prefix_count: type: integer format: int64 readOnly: true rack_count: type: integer format: int64 readOnly: true virtualmachine_count: type: integer format: int64 readOnly: true vlan_count: type: integer format: int64 readOnly: true required: - circuit_count - created - device_count - display - display_url - id - last_updated - name - prefix_count - rack_count - slug - url - virtualmachine_count - vlan_count PlatformRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: parent: allOf: - $ref: '#/components/schemas/NestedPlatformRequest' nullable: true name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ manufacturer: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefManufacturerRequest' nullable: true nullable: true config_template: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefConfigTemplateRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug NestedRegion: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ _depth: type: integer readOnly: true title: ' depth' required: - _depth - display - display_url - id - name - slug - url Interface: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' vdcs: type: array items: $ref: '#/components/schemas/VirtualDeviceContext' module: allOf: - $ref: '#/components/schemas/BriefModule' nullable: true name: type: string maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - virtual - bridge - lag - 100base-fx - 100base-lfx - 100base-tx - 100base-t1 - 1000base-bx10-d - 1000base-bx10-u - 1000base-cwdm - 1000base-cx - 1000base-dwdm - 1000base-ex - 1000base-lsx - 1000base-lx - 1000base-lx10 - 1000base-sx - 1000base-t - 1000base-tx - 1000base-zx - 2.5gbase-t - 5gbase-t - 10gbase-br-d - 10gbase-br-u - 10gbase-cu - 10gbase-cx4 - 10gbase-er - 10gbase-lr - 10gbase-lrm - 10gbase-lx4 - 10gbase-sr - 10gbase-t - 10gbase-zr - 25gbase-cr - 25gbase-er - 25gbase-lr - 25gbase-sr - 25gbase-t - 40gbase-cr4 - 40gbase-er4 - 40gbase-fr4 - 40gbase-lr4 - 40gbase-sr4 - 40gbase-sr4-bd - 50gbase-cr - 50gbase-er - 50gbase-fr - 50gbase-lr - 50gbase-sr - 100gbase-cr1 - 100gbase-cr2 - 100gbase-cr4 - 100gbase-cr10 - 100gbase-cwdm4 - 100gbase-dr - 100gbase-er4 - 100gbase-fr1 - 100gbase-lr1 - 100gbase-lr4 - 100gbase-sr1 - 100gbase-sr1.2 - 100gbase-sr2 - 100gbase-sr4 - 100gbase-sr10 - 100gbase-zr - 200gbase-cr2 - 200gbase-cr4 - 200gbase-dr4 - 200gbase-er4 - 200gbase-fr4 - 200gbase-lr4 - 200gbase-sr2 - 200gbase-sr4 - 200gbase-vr2 - 400gbase-cr4 - 400gbase-dr4 - 400gbase-er8 - 400gbase-fr4 - 400gbase-fr8 - 400gbase-lr4 - 400gbase-lr8 - 400gbase-sr4 - 400gbase-sr4_2 - 400gbase-sr8 - 400gbase-sr16 - 400gbase-vr4 - 400gbase-zr - 800gbase-cr8 - 800gbase-dr8 - 800gbase-sr8 - 800gbase-vr8 - 1.6tbase-cr8 - 1.6tbase-dr8 - 1.6tbase-dr8-2 - 100base-x-sfp - 1000base-x-gbic - 1000base-x-sfp - 2.5gbase-x-sfp - 10gbase-x-sfpp - 10gbase-x-xenpak - 10gbase-x-xfp - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 50gbase-x-sfp56 - 100gbase-x-cfp - 100gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cxp - 100gbase-x-cpak - 100gbase-x-dsfp - 100gbase-x-qsfp28 - 100gbase-x-qsfpdd - 100gbase-x-sfpdd - 200gbase-x-cfp2 - 200gbase-x-qsfp56 - 200gbase-x-qsfpdd - 400gbase-x-qsfp112 - 400gbase-x-qsfpdd - 400gbase-x-cdfp - 400gbase-x-cfp2 - 400gbase-x-cfp8 - 400gbase-x-osfp - 400gbase-x-osfp-rhs - 800gbase-x-osfp - 800gbase-x-qsfpdd - 1.6tbase-x-osfp1600 - 1.6tbase-x-osfp1600-rhs - 1.6tbase-x-qsfpdd1600 - 1000base-kx - 2.5gbase-kx - 5gbase-kr - 10gbase-kr - 10gbase-kx4 - 25gbase-kr - 40gbase-kr4 - 50gbase-kr - 100gbase-kp4 - 100gbase-kr2 - 100gbase-kr4 - 1.6tbase-kr8 - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - ieee802.11ay - ieee802.11be - ieee802.15.1 - ieee802.15.4 - other-wireless - gsm - cdma - lte - 4g - 5g - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 32gfc-sfpp - 64gfc-qsfpp - 64gfc-sfpdd - 64gfc-sfpp - 128gfc-qsfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - xdsl - docsis - moca - bpon - epon - 10g-epon - gpon - xg-pon - xgs-pon - ng-pon2 - 25g-pon - 50g-pon - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - cisco-stackwise-80 - cisco-stackwise-160 - cisco-stackwise-320 - cisco-stackwise-480 - cisco-stackwise-1t - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string description: '* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) * `100base-fx` - 100BASE-FX (10/100ME) * `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) * `100base-t1` - 100BASE-T1 (10/100ME) * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) * `1000base-cwdm` - 1000BASE-CWDM (1GE) * `1000base-cx` - 1000BASE-CX (1GE DAC) * `1000base-dwdm` - 1000BASE-DWDM (1GE) * `1000base-ex` - 1000BASE-EX (1GE) * `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) * `1000base-lx10` - 1000BASE-LX10/LH (1GE) * `1000base-sx` - 1000BASE-SX (1GE) * `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) * `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) * `10gbase-er` - 10GBASE-ER (10GE) * `10gbase-lr` - 10GBASE-LR (10GE) * `10gbase-lrm` - 10GBASE-LRM (10GE) * `10gbase-lx4` - 10GBASE-LX4 (10GE) * `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) * `10gbase-zr` - 10GBASE-ZR (10GE) * `25gbase-cr` - 25GBASE-CR (25GE DAC) * `25gbase-er` - 25GBASE-ER (25GE) * `25gbase-lr` - 25GBASE-LR (25GE) * `25gbase-sr` - 25GBASE-SR (25GE) * `25gbase-t` - 25GBASE-T (25GE) * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) * `40gbase-er4` - 40GBASE-ER4 (40GE) * `40gbase-fr4` - 40GBASE-FR4 (40GE) * `40gbase-lr4` - 40GBASE-LR4 (40GE) * `40gbase-sr4` - 40GBASE-SR4 (40GE) * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) * `50gbase-cr` - 50GBASE-CR (50GE DAC) * `50gbase-er` - 50GBASE-ER (50GE) * `50gbase-fr` - 50GBASE-FR (50GE) * `50gbase-lr` - 50GBASE-LR (50GE) * `50gbase-sr` - 50GBASE-SR (50GE) * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) * `100gbase-dr` - 100GBASE-DR (100GE) * `100gbase-er4` - 100GBASE-ER4 (100GE) * `100gbase-fr1` - 100GBASE-FR1 (100GE) * `100gbase-lr1` - 100GBASE-LR1 (100GE) * `100gbase-lr4` - 100GBASE-LR4 (100GE) * `100gbase-sr1` - 100GBASE-SR1 (100GE) * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) * `100gbase-sr2` - 100GBASE-SR2 (100GE) * `100gbase-sr4` - 100GBASE-SR4 (100GE) * `100gbase-sr10` - 100GBASE-SR10 (100GE) * `100gbase-zr` - 100GBASE-ZR (100GE) * `200gbase-cr2` - 200GBASE-CR2 (200GE) * `200gbase-cr4` - 200GBASE-CR4 (200GE) * `200gbase-dr4` - 200GBASE-DR4 (200GE) * `200gbase-er4` - 200GBASE-ER4 (200GE) * `200gbase-fr4` - 200GBASE-FR4 (200GE) * `200gbase-lr4` - 200GBASE-LR4 (200GE) * `200gbase-sr2` - 200GBASE-SR2 (200GE) * `200gbase-sr4` - 200GBASE-SR4 (200GE) * `200gbase-vr2` - 200GBASE-VR2 (200GE) * `400gbase-cr4` - 400GBASE-CR4 (400GE) * `400gbase-dr4` - 400GBASE-DR4 (400GE) * `400gbase-er8` - 400GBASE-ER8 (400GE) * `400gbase-fr4` - 400GBASE-FR4 (400GE) * `400gbase-fr8` - 400GBASE-FR8 (400GE) * `400gbase-lr4` - 400GBASE-LR4 (400GE) * `400gbase-lr8` - 400GBASE-LR8 (400GE) * `400gbase-sr4` - 400GBASE-SR4 (400GE) * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) * `400gbase-sr8` - 400GBASE-SR8 (400GE) * `400gbase-sr16` - 400GBASE-SR16 (400GE) * `400gbase-vr4` - 400GBASE-VR4 (400GE) * `400gbase-zr` - 400GBASE-ZR (400GE) * `800gbase-cr8` - 800GBASE-CR8 (800GE) * `800gbase-dr8` - 800GBASE-DR8 (800GE) * `800gbase-sr8` - 800GBASE-SR8 (800GE) * `800gbase-vr8` - 800GBASE-VR8 (800GE) * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) * `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) * `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) * `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) * `100gbase-x-sfpdd` - SFP-DD (100GE) * `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) * `400gbase-x-cdfp` - CDFP (400GE) * `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) * `400gbase-x-osfp` - OSFP (400GE) * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) * `800gbase-x-qsfpdd` - QSFP-DD (800GE) * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) * `10gbase-kr` - 10GBASE-KR (10GE) * `10gbase-kx4` - 10GBASE-KX4 (10GE) * `25gbase-kr` - 25GBASE-KR (25GE) * `40gbase-kr4` - 40GBASE-KR4 (40GE) * `50gbase-kr` - 50GBASE-KR (50GE) * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) * `ieee802.11ad` - IEEE 802.11ad (WiGig) * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) * `ieee802.11ay` - IEEE 802.11ay (WiGig) * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) * `gsm` - GSM * `cdma` - CDMA * `lte` - LTE * `4g` - 4G * `5g` - 5G * `sonet-oc3` - OC-3/STM-1 * `sonet-oc12` - OC-12/STM-4 * `sonet-oc48` - OC-48/STM-16 * `sonet-oc192` - OC-192/STM-64 * `sonet-oc768` - OC-768/STM-256 * `sonet-oc1920` - OC-1920/STM-640 * `sonet-oc3840` - OC-3840/STM-1234 * `1gfc-sfp` - SFP (1GFC) * `2gfc-sfp` - SFP (2GFC) * `4gfc-sfp` - SFP (4GFC) * `8gfc-sfpp` - SFP+ (8GFC) * `16gfc-sfpp` - SFP+ (16GFC) * `32gfc-sfp28` - SFP28 (32GFC) * `32gfc-sfpp` - SFP+ (32GFC) * `64gfc-qsfpp` - QSFP+ (64GFC) * `64gfc-sfpdd` - SFP-DD (64GFC) * `64gfc-sfpp` - SFP+ (64GFC) * `128gfc-qsfp28` - QSFP28 (128GFC) * `infiniband-sdr` - SDR (2 Gbps) * `infiniband-ddr` - DDR (4 Gbps) * `infiniband-qdr` - QDR (8 Gbps) * `infiniband-fdr10` - FDR10 (10 Gbps) * `infiniband-fdr` - FDR (13.5 Gbps) * `infiniband-edr` - EDR (25 Gbps) * `infiniband-hdr` - HDR (50 Gbps) * `infiniband-ndr` - NDR (100 Gbps) * `infiniband-xdr` - XDR (250 Gbps) * `t1` - T1 (1.544 Mbps) * `e1` - E1 (2.048 Mbps) * `t3` - T3 (45 Mbps) * `e3` - E3 (34 Mbps) * `xdsl` - xDSL * `docsis` - DOCSIS * `moca` - MoCA * `bpon` - BPON (622 Mbps / 155 Mbps) * `epon` - EPON (1 Gbps) * `10g-epon` - 10G-EPON (10 Gbps) * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) * `xgs-pon` - XGS-PON (10 Gbps) * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) * `25g-pon` - 25G-PON (25 Gbps) * `50g-pon` - 50G-PON (50 Gbps) * `cisco-stackwise` - Cisco StackWise * `cisco-stackwise-plus` - Cisco StackWise Plus * `cisco-flexstack` - Cisco FlexStack * `cisco-flexstack-plus` - Cisco FlexStack Plus * `cisco-stackwise-80` - Cisco StackWise-80 * `cisco-stackwise-160` - Cisco StackWise-160 * `cisco-stackwise-320` - Cisco StackWise-320 * `cisco-stackwise-480` - Cisco StackWise-480 * `cisco-stackwise-1t` - Cisco StackWise-1T * `juniper-vcp` - Juniper VCP * `extreme-summitstack` - Extreme SummitStack * `extreme-summitstack-128` - Extreme SummitStack-128 * `extreme-summitstack-256` - Extreme SummitStack-256 * `extreme-summitstack-512` - Extreme SummitStack-512 * `other` - Other' x-spec-enum-id: b067eb1f050c6ae9 label: type: string enum: - Virtual - Bridge - Link Aggregation Group (LAG) - 100BASE-FX (10/100ME) - 100BASE-LFX (10/100ME) - 100BASE-TX (10/100ME) - 100BASE-T1 (10/100ME) - 1000BASE-BX10-D (1GE BiDi Down) - 1000BASE-BX10-U (1GE BiDi Up) - 1000BASE-CWDM (1GE) - 1000BASE-CX (1GE DAC) - 1000BASE-DWDM (1GE) - 1000BASE-EX (1GE) - 1000BASE-LSX (1GE) - 1000BASE-LX (1GE) - 1000BASE-LX10/LH (1GE) - 1000BASE-SX (1GE) - 1000BASE-T (1GE) - 1000BASE-TX (1GE) - 1000BASE-ZX (1GE) - 2.5GBASE-T (2.5GE) - 5GBASE-T (5GE) - 10GBASE-BR-D (10GE BiDi Down) - 10GBASE-BR-U (10GE BiDi Up) - 10GBASE-CU (10GE DAC Passive Twinax) - 10GBASE-CX4 (10GE DAC) - 10GBASE-ER (10GE) - 10GBASE-LR (10GE) - 10GBASE-LRM (10GE) - 10GBASE-LX4 (10GE) - 10GBASE-SR (10GE) - 10GBASE-T (10GE) - 10GBASE-ZR (10GE) - 25GBASE-CR (25GE DAC) - 25GBASE-ER (25GE) - 25GBASE-LR (25GE) - 25GBASE-SR (25GE) - 25GBASE-T (25GE) - 40GBASE-CR4 (40GE DAC) - 40GBASE-ER4 (40GE) - 40GBASE-FR4 (40GE) - 40GBASE-LR4 (40GE) - 40GBASE-SR4 (40GE) - 40GBASE-SR4 (40GE BiDi) - 50GBASE-CR (50GE DAC) - 50GBASE-ER (50GE) - 50GBASE-FR (50GE) - 50GBASE-LR (50GE) - 50GBASE-SR (50GE) - 100GBASE-CR1 (100GE DAC) - 100GBASE-CR2 (100GE DAC) - 100GBASE-CR4 (100GE DAC) - 100GBASE-CR10 (100GE DAC) - 100GBASE-CWDM4 (100GE) - 100GBASE-DR (100GE) - 100GBASE-ER4 (100GE) - 100GBASE-FR1 (100GE) - 100GBASE-LR1 (100GE) - 100GBASE-LR4 (100GE) - 100GBASE-SR1 (100GE) - 100GBASE-SR1.2 (100GE BiDi) - 100GBASE-SR2 (100GE) - 100GBASE-SR4 (100GE) - 100GBASE-SR10 (100GE) - 100GBASE-ZR (100GE) - 200GBASE-CR2 (200GE) - 200GBASE-CR4 (200GE) - 200GBASE-DR4 (200GE) - 200GBASE-ER4 (200GE) - 200GBASE-FR4 (200GE) - 200GBASE-LR4 (200GE) - 200GBASE-SR2 (200GE) - 200GBASE-SR4 (200GE) - 200GBASE-VR2 (200GE) - 400GBASE-CR4 (400GE) - 400GBASE-DR4 (400GE) - 400GBASE-ER8 (400GE) - 400GBASE-FR4 (400GE) - 400GBASE-FR8 (400GE) - 400GBASE-LR4 (400GE) - 400GBASE-LR8 (400GE) - 400GBASE-SR4 (400GE) - 400GBASE-SR4.2 (400GE BiDi) - 400GBASE-SR8 (400GE) - 400GBASE-SR16 (400GE) - 400GBASE-VR4 (400GE) - 400GBASE-ZR (400GE) - 800GBASE-CR8 (800GE) - 800GBASE-DR8 (800GE) - 800GBASE-SR8 (800GE) - 800GBASE-VR8 (800GE) - 1.6TBASE-CR8 (1.6TE) - 1.6TBASE-DR8 (1.6TE) - 1.6TBASE-DR8-2 (1.6TE) - SFP (100ME) - GBIC (1GE) - SFP (1GE) - SFP (2.5GE) - SFP+ (10GE) - XENPAK (10GE) - XFP (10GE) - X2 (10GE) - SFP28 (25GE) - QSFP+ (40GE) - QSFP28 (50GE) - SFP56 (50GE) - CFP (100GE) - CFP2 (100GE) - CFP4 (100GE) - CXP (100GE) - Cisco CPAK (100GE) - DSFP (100GE) - QSFP28 (100GE) - QSFP-DD (100GE) - SFP-DD (100GE) - CFP2 (200GE) - QSFP56 (200GE) - QSFP-DD (200GE) - QSFP112 (400GE) - QSFP-DD (400GE) - CDFP (400GE) - CFP2 (400GE) - CPF8 (400GE) - OSFP (400GE) - OSFP-RHS (400GE) - OSFP (800GE) - QSFP-DD (800GE) - OSFP1600 (1.6TE) - OSFP1600-RHS (1.6TE) - QSFP-DD1600 (1.6TE) - 1000BASE-KX (1GE) - 2.5GBASE-KX (2.5GE) - 5GBASE-KR (5GE) - 10GBASE-KR (10GE) - 10GBASE-KX4 (10GE) - 25GBASE-KR (25GE) - 40GBASE-KR4 (40GE) - 50GBASE-KR (50GE) - 100GBASE-KP4 (100GE) - 100GBASE-KR2 (100GE) - 100GBASE-KR4 (100GE) - 1.6TBASE-KR8 (1.6TE) - IEEE 802.11a - IEEE 802.11b/g - IEEE 802.11n (Wi-Fi 4) - IEEE 802.11ac (Wi-Fi 5) - IEEE 802.11ad (WiGig) - IEEE 802.11ax (Wi-Fi 6) - IEEE 802.11ay (WiGig) - IEEE 802.11be (Wi-Fi 7) - IEEE 802.15.1 (Bluetooth) - IEEE 802.15.4 (LR-WPAN) - Other (Wireless) - GSM - CDMA - LTE - 4G - 5G - OC-3/STM-1 - OC-12/STM-4 - OC-48/STM-16 - OC-192/STM-64 - OC-768/STM-256 - OC-1920/STM-640 - OC-3840/STM-1234 - SFP (1GFC) - SFP (2GFC) - SFP (4GFC) - SFP+ (8GFC) - SFP+ (16GFC) - SFP28 (32GFC) - SFP+ (32GFC) - QSFP+ (64GFC) - SFP-DD (64GFC) - SFP+ (64GFC) - QSFP28 (128GFC) - SDR (2 Gbps) - DDR (4 Gbps) - QDR (8 Gbps) - FDR10 (10 Gbps) - FDR (13.5 Gbps) - EDR (25 Gbps) - HDR (50 Gbps) - NDR (100 Gbps) - XDR (250 Gbps) - T1 (1.544 Mbps) - E1 (2.048 Mbps) - T3 (45 Mbps) - E3 (34 Mbps) - xDSL - DOCSIS - MoCA - BPON (622 Mbps / 155 Mbps) - EPON (1 Gbps) - 10G-EPON (10 Gbps) - GPON (2.5 Gbps / 1.25 Gbps) - XG-PON (10 Gbps / 2.5 Gbps) - XGS-PON (10 Gbps) - NG-PON2 (TWDM-PON) (4x10 Gbps) - 25G-PON (25 Gbps) - 50G-PON (50 Gbps) - Cisco StackWise - Cisco StackWise Plus - Cisco FlexStack - Cisco FlexStack Plus - Cisco StackWise-80 - Cisco StackWise-160 - Cisco StackWise-320 - Cisco StackWise-480 - Cisco StackWise-1T - Juniper VCP - Extreme SummitStack - Extreme SummitStack-128 - Extreme SummitStack-256 - Extreme SummitStack-512 - Other enabled: type: boolean parent: allOf: - $ref: '#/components/schemas/NestedInterface' nullable: true bridge: allOf: - $ref: '#/components/schemas/NestedInterface' nullable: true bridge_interfaces: type: array items: $ref: '#/components/schemas/NestedInterface' readOnly: true lag: allOf: - $ref: '#/components/schemas/NestedInterface' nullable: true mtu: type: integer maximum: 65536 minimum: 1 nullable: true mac_address: type: string readOnly: true nullable: true primary_mac_address: allOf: - $ref: '#/components/schemas/BriefMACAddress' nullable: true mac_addresses: type: array items: $ref: '#/components/schemas/BriefMACAddress' readOnly: true nullable: true speed: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true title: Speed (Kbps) duplex: type: object properties: value: enum: - half - full - auto - '' - null type: string description: '* `half` - Half * `full` - Full * `auto` - Auto' x-spec-enum-id: 368458a2b67c916b label: type: string enum: - Half - Full - Auto nullable: true wwn: type: string nullable: true mgmt_only: type: boolean title: Management only description: This interface is used only for out-of-band management description: type: string maxLength: 200 mode: type: object properties: value: enum: - access - tagged - tagged-all - q-in-q - '' type: string description: '* `access` - Access * `tagged` - Tagged * `tagged-all` - Tagged (All) * `q-in-q` - Q-in-Q (802.1ad)' x-spec-enum-id: 84129b71b974ebe5 label: type: string enum: - Access - Tagged - Tagged (All) - Q-in-Q (802.1ad) rf_role: type: object properties: value: enum: - ap - station - '' type: string description: '* `ap` - Access point * `station` - Station' x-spec-enum-id: d2772dbea88b0fb1 label: type: string enum: - Access point - Station rf_channel: type: object properties: value: enum: - 2.4g-1-2412-22 - 2.4g-2-2417-22 - 2.4g-3-2422-22 - 2.4g-4-2427-22 - 2.4g-5-2432-22 - 2.4g-6-2437-22 - 2.4g-7-2442-22 - 2.4g-8-2447-22 - 2.4g-9-2452-22 - 2.4g-10-2457-22 - 2.4g-11-2462-22 - 2.4g-12-2467-22 - 2.4g-13-2472-22 - 5g-32-5160-20 - 5g-34-5170-40 - 5g-36-5180-20 - 5g-38-5190-40 - 5g-40-5200-20 - 5g-42-5210-80 - 5g-44-5220-20 - 5g-46-5230-40 - 5g-48-5240-20 - 5g-50-5250-160 - 5g-52-5260-20 - 5g-54-5270-40 - 5g-56-5280-20 - 5g-58-5290-80 - 5g-60-5300-20 - 5g-62-5310-40 - 5g-64-5320-20 - 5g-100-5500-20 - 5g-102-5510-40 - 5g-104-5520-20 - 5g-106-5530-80 - 5g-108-5540-20 - 5g-110-5550-40 - 5g-112-5560-20 - 5g-114-5570-160 - 5g-116-5580-20 - 5g-118-5590-40 - 5g-120-5600-20 - 5g-122-5610-80 - 5g-124-5620-20 - 5g-126-5630-40 - 5g-128-5640-20 - 5g-132-5660-20 - 5g-134-5670-40 - 5g-136-5680-20 - 5g-138-5690-80 - 5g-140-5700-20 - 5g-142-5710-40 - 5g-144-5720-20 - 5g-149-5745-20 - 5g-151-5755-40 - 5g-153-5765-20 - 5g-155-5775-80 - 5g-157-5785-20 - 5g-159-5795-40 - 5g-161-5805-20 - 5g-163-5815-160 - 5g-165-5825-20 - 5g-167-5835-40 - 5g-169-5845-20 - 5g-171-5855-80 - 5g-173-5865-20 - 5g-175-5875-40 - 5g-177-5885-20 - 6g-1-5955-20 - 6g-3-5965-40 - 6g-5-5975-20 - 6g-7-5985-80 - 6g-9-5995-20 - 6g-11-6005-40 - 6g-13-6015-20 - 6g-15-6025-160 - 6g-17-6035-20 - 6g-19-6045-40 - 6g-21-6055-20 - 6g-23-6065-80 - 6g-25-6075-20 - 6g-27-6085-40 - 6g-29-6095-20 - 6g-31-6105-320 - 6g-33-6115-20 - 6g-35-6125-40 - 6g-37-6135-20 - 6g-39-6145-80 - 6g-41-6155-20 - 6g-43-6165-40 - 6g-45-6175-20 - 6g-47-6185-160 - 6g-49-6195-20 - 6g-51-6205-40 - 6g-53-6215-20 - 6g-55-6225-80 - 6g-57-6235-20 - 6g-59-6245-40 - 6g-61-6255-20 - 6g-65-6275-20 - 6g-67-6285-40 - 6g-69-6295-20 - 6g-71-6305-80 - 6g-73-6315-20 - 6g-75-6325-40 - 6g-77-6335-20 - 6g-79-6345-160 - 6g-81-6355-20 - 6g-83-6365-40 - 6g-85-6375-20 - 6g-87-6385-80 - 6g-89-6395-20 - 6g-91-6405-40 - 6g-93-6415-20 - 6g-95-6425-320 - 6g-97-6435-20 - 6g-99-6445-40 - 6g-101-6455-20 - 6g-103-6465-80 - 6g-105-6475-20 - 6g-107-6485-40 - 6g-109-6495-20 - 6g-111-6505-160 - 6g-113-6515-20 - 6g-115-6525-40 - 6g-117-6535-20 - 6g-119-6545-80 - 6g-121-6555-20 - 6g-123-6565-40 - 6g-125-6575-20 - 6g-129-6595-20 - 6g-131-6605-40 - 6g-133-6615-20 - 6g-135-6625-80 - 6g-137-6635-20 - 6g-139-6645-40 - 6g-141-6655-20 - 6g-143-6665-160 - 6g-145-6675-20 - 6g-147-6685-40 - 6g-149-6695-20 - 6g-151-6705-80 - 6g-153-6715-20 - 6g-155-6725-40 - 6g-157-6735-20 - 6g-159-6745-320 - 6g-161-6755-20 - 6g-163-6765-40 - 6g-165-6775-20 - 6g-167-6785-80 - 6g-169-6795-20 - 6g-171-6805-40 - 6g-173-6815-20 - 6g-175-6825-160 - 6g-177-6835-20 - 6g-179-6845-40 - 6g-181-6855-20 - 6g-183-6865-80 - 6g-185-6875-20 - 6g-187-6885-40 - 6g-189-6895-20 - 6g-193-6915-20 - 6g-195-6925-40 - 6g-197-6935-20 - 6g-199-6945-80 - 6g-201-6955-20 - 6g-203-6965-40 - 6g-205-6975-20 - 6g-207-6985-160 - 6g-209-6995-20 - 6g-211-7005-40 - 6g-213-7015-20 - 6g-215-7025-80 - 6g-217-7035-20 - 6g-219-7045-40 - 6g-221-7055-20 - 6g-225-7075-20 - 6g-227-7085-40 - 6g-229-7095-20 - 6g-233-7115-20 - 60g-1-58320-2160 - 60g-2-60480-2160 - 60g-3-62640-2160 - 60g-4-64800-2160 - 60g-5-66960-2160 - 60g-6-69120-2160 - 60g-9-59400-4320 - 60g-10-61560-4320 - 60g-11-63720-4320 - 60g-12-65880-4320 - 60g-13-68040-4320 - 60g-17-60480-6480 - 60g-18-62640-6480 - 60g-19-64800-6480 - 60g-20-66960-6480 - 60g-25-61560-6480 - 60g-26-63720-6480 - 60g-27-65880-6480 - '' type: string description: '* `2.4g-1-2412-22` - 1 (2412 MHz) * `2.4g-2-2417-22` - 2 (2417 MHz) * `2.4g-3-2422-22` - 3 (2422 MHz) * `2.4g-4-2427-22` - 4 (2427 MHz) * `2.4g-5-2432-22` - 5 (2432 MHz) * `2.4g-6-2437-22` - 6 (2437 MHz) * `2.4g-7-2442-22` - 7 (2442 MHz) * `2.4g-8-2447-22` - 8 (2447 MHz) * `2.4g-9-2452-22` - 9 (2452 MHz) * `2.4g-10-2457-22` - 10 (2457 MHz) * `2.4g-11-2462-22` - 11 (2462 MHz) * `2.4g-12-2467-22` - 12 (2467 MHz) * `2.4g-13-2472-22` - 13 (2472 MHz) * `5g-32-5160-20` - 32 (5160/20 MHz) * `5g-34-5170-40` - 34 (5170/40 MHz) * `5g-36-5180-20` - 36 (5180/20 MHz) * `5g-38-5190-40` - 38 (5190/40 MHz) * `5g-40-5200-20` - 40 (5200/20 MHz) * `5g-42-5210-80` - 42 (5210/80 MHz) * `5g-44-5220-20` - 44 (5220/20 MHz) * `5g-46-5230-40` - 46 (5230/40 MHz) * `5g-48-5240-20` - 48 (5240/20 MHz) * `5g-50-5250-160` - 50 (5250/160 MHz) * `5g-52-5260-20` - 52 (5260/20 MHz) * `5g-54-5270-40` - 54 (5270/40 MHz) * `5g-56-5280-20` - 56 (5280/20 MHz) * `5g-58-5290-80` - 58 (5290/80 MHz) * `5g-60-5300-20` - 60 (5300/20 MHz) * `5g-62-5310-40` - 62 (5310/40 MHz) * `5g-64-5320-20` - 64 (5320/20 MHz) * `5g-100-5500-20` - 100 (5500/20 MHz) * `5g-102-5510-40` - 102 (5510/40 MHz) * `5g-104-5520-20` - 104 (5520/20 MHz) * `5g-106-5530-80` - 106 (5530/80 MHz) * `5g-108-5540-20` - 108 (5540/20 MHz) * `5g-110-5550-40` - 110 (5550/40 MHz) * `5g-112-5560-20` - 112 (5560/20 MHz) * `5g-114-5570-160` - 114 (5570/160 MHz) * `5g-116-5580-20` - 116 (5580/20 MHz) * `5g-118-5590-40` - 118 (5590/40 MHz) * `5g-120-5600-20` - 120 (5600/20 MHz) * `5g-122-5610-80` - 122 (5610/80 MHz) * `5g-124-5620-20` - 124 (5620/20 MHz) * `5g-126-5630-40` - 126 (5630/40 MHz) * `5g-128-5640-20` - 128 (5640/20 MHz) * `5g-132-5660-20` - 132 (5660/20 MHz) * `5g-134-5670-40` - 134 (5670/40 MHz) * `5g-136-5680-20` - 136 (5680/20 MHz) * `5g-138-5690-80` - 138 (5690/80 MHz) * `5g-140-5700-20` - 140 (5700/20 MHz) * `5g-142-5710-40` - 142 (5710/40 MHz) * `5g-144-5720-20` - 144 (5720/20 MHz) * `5g-149-5745-20` - 149 (5745/20 MHz) * `5g-151-5755-40` - 151 (5755/40 MHz) * `5g-153-5765-20` - 153 (5765/20 MHz) * `5g-155-5775-80` - 155 (5775/80 MHz) * `5g-157-5785-20` - 157 (5785/20 MHz) * `5g-159-5795-40` - 159 (5795/40 MHz) * `5g-161-5805-20` - 161 (5805/20 MHz) * `5g-163-5815-160` - 163 (5815/160 MHz) * `5g-165-5825-20` - 165 (5825/20 MHz) * `5g-167-5835-40` - 167 (5835/40 MHz) * `5g-169-5845-20` - 169 (5845/20 MHz) * `5g-171-5855-80` - 171 (5855/80 MHz) * `5g-173-5865-20` - 173 (5865/20 MHz) * `5g-175-5875-40` - 175 (5875/40 MHz) * `5g-177-5885-20` - 177 (5885/20 MHz) * `6g-1-5955-20` - 1 (5955/20 MHz) * `6g-3-5965-40` - 3 (5965/40 MHz) * `6g-5-5975-20` - 5 (5975/20 MHz) * `6g-7-5985-80` - 7 (5985/80 MHz) * `6g-9-5995-20` - 9 (5995/20 MHz) * `6g-11-6005-40` - 11 (6005/40 MHz) * `6g-13-6015-20` - 13 (6015/20 MHz) * `6g-15-6025-160` - 15 (6025/160 MHz) * `6g-17-6035-20` - 17 (6035/20 MHz) * `6g-19-6045-40` - 19 (6045/40 MHz) * `6g-21-6055-20` - 21 (6055/20 MHz) * `6g-23-6065-80` - 23 (6065/80 MHz) * `6g-25-6075-20` - 25 (6075/20 MHz) * `6g-27-6085-40` - 27 (6085/40 MHz) * `6g-29-6095-20` - 29 (6095/20 MHz) * `6g-31-6105-320` - 31 (6105/320 MHz) * `6g-33-6115-20` - 33 (6115/20 MHz) * `6g-35-6125-40` - 35 (6125/40 MHz) * `6g-37-6135-20` - 37 (6135/20 MHz) * `6g-39-6145-80` - 39 (6145/80 MHz) * `6g-41-6155-20` - 41 (6155/20 MHz) * `6g-43-6165-40` - 43 (6165/40 MHz) * `6g-45-6175-20` - 45 (6175/20 MHz) * `6g-47-6185-160` - 47 (6185/160 MHz) * `6g-49-6195-20` - 49 (6195/20 MHz) * `6g-51-6205-40` - 51 (6205/40 MHz) * `6g-53-6215-20` - 53 (6215/20 MHz) * `6g-55-6225-80` - 55 (6225/80 MHz) * `6g-57-6235-20` - 57 (6235/20 MHz) * `6g-59-6245-40` - 59 (6245/40 MHz) * `6g-61-6255-20` - 61 (6255/20 MHz) * `6g-65-6275-20` - 65 (6275/20 MHz) * `6g-67-6285-40` - 67 (6285/40 MHz) * `6g-69-6295-20` - 69 (6295/20 MHz) * `6g-71-6305-80` - 71 (6305/80 MHz) * `6g-73-6315-20` - 73 (6315/20 MHz) * `6g-75-6325-40` - 75 (6325/40 MHz) * `6g-77-6335-20` - 77 (6335/20 MHz) * `6g-79-6345-160` - 79 (6345/160 MHz) * `6g-81-6355-20` - 81 (6355/20 MHz) * `6g-83-6365-40` - 83 (6365/40 MHz) * `6g-85-6375-20` - 85 (6375/20 MHz) * `6g-87-6385-80` - 87 (6385/80 MHz) * `6g-89-6395-20` - 89 (6395/20 MHz) * `6g-91-6405-40` - 91 (6405/40 MHz) * `6g-93-6415-20` - 93 (6415/20 MHz) * `6g-95-6425-320` - 95 (6425/320 MHz) * `6g-97-6435-20` - 97 (6435/20 MHz) * `6g-99-6445-40` - 99 (6445/40 MHz) * `6g-101-6455-20` - 101 (6455/20 MHz) * `6g-103-6465-80` - 103 (6465/80 MHz) * `6g-105-6475-20` - 105 (6475/20 MHz) * `6g-107-6485-40` - 107 (6485/40 MHz) * `6g-109-6495-20` - 109 (6495/20 MHz) * `6g-111-6505-160` - 111 (6505/160 MHz) * `6g-113-6515-20` - 113 (6515/20 MHz) * `6g-115-6525-40` - 115 (6525/40 MHz) * `6g-117-6535-20` - 117 (6535/20 MHz) * `6g-119-6545-80` - 119 (6545/80 MHz) * `6g-121-6555-20` - 121 (6555/20 MHz) * `6g-123-6565-40` - 123 (6565/40 MHz) * `6g-125-6575-20` - 125 (6575/20 MHz) * `6g-129-6595-20` - 129 (6595/20 MHz) * `6g-131-6605-40` - 131 (6605/40 MHz) * `6g-133-6615-20` - 133 (6615/20 MHz) * `6g-135-6625-80` - 135 (6625/80 MHz) * `6g-137-6635-20` - 137 (6635/20 MHz) * `6g-139-6645-40` - 139 (6645/40 MHz) * `6g-141-6655-20` - 141 (6655/20 MHz) * `6g-143-6665-160` - 143 (6665/160 MHz) * `6g-145-6675-20` - 145 (6675/20 MHz) * `6g-147-6685-40` - 147 (6685/40 MHz) * `6g-149-6695-20` - 149 (6695/20 MHz) * `6g-151-6705-80` - 151 (6705/80 MHz) * `6g-153-6715-20` - 153 (6715/20 MHz) * `6g-155-6725-40` - 155 (6725/40 MHz) * `6g-157-6735-20` - 157 (6735/20 MHz) * `6g-159-6745-320` - 159 (6745/320 MHz) * `6g-161-6755-20` - 161 (6755/20 MHz) * `6g-163-6765-40` - 163 (6765/40 MHz) * `6g-165-6775-20` - 165 (6775/20 MHz) * `6g-167-6785-80` - 167 (6785/80 MHz) * `6g-169-6795-20` - 169 (6795/20 MHz) * `6g-171-6805-40` - 171 (6805/40 MHz) * `6g-173-6815-20` - 173 (6815/20 MHz) * `6g-175-6825-160` - 175 (6825/160 MHz) * `6g-177-6835-20` - 177 (6835/20 MHz) * `6g-179-6845-40` - 179 (6845/40 MHz) * `6g-181-6855-20` - 181 (6855/20 MHz) * `6g-183-6865-80` - 183 (6865/80 MHz) * `6g-185-6875-20` - 185 (6875/20 MHz) * `6g-187-6885-40` - 187 (6885/40 MHz) * `6g-189-6895-20` - 189 (6895/20 MHz) * `6g-193-6915-20` - 193 (6915/20 MHz) * `6g-195-6925-40` - 195 (6925/40 MHz) * `6g-197-6935-20` - 197 (6935/20 MHz) * `6g-199-6945-80` - 199 (6945/80 MHz) * `6g-201-6955-20` - 201 (6955/20 MHz) * `6g-203-6965-40` - 203 (6965/40 MHz) * `6g-205-6975-20` - 205 (6975/20 MHz) * `6g-207-6985-160` - 207 (6985/160 MHz) * `6g-209-6995-20` - 209 (6995/20 MHz) * `6g-211-7005-40` - 211 (7005/40 MHz) * `6g-213-7015-20` - 213 (7015/20 MHz) * `6g-215-7025-80` - 215 (7025/80 MHz) * `6g-217-7035-20` - 217 (7035/20 MHz) * `6g-219-7045-40` - 219 (7045/40 MHz) * `6g-221-7055-20` - 221 (7055/20 MHz) * `6g-225-7075-20` - 225 (7075/20 MHz) * `6g-227-7085-40` - 227 (7085/40 MHz) * `6g-229-7095-20` - 229 (7095/20 MHz) * `6g-233-7115-20` - 233 (7115/20 MHz) * `60g-1-58320-2160` - 1 (58.32/2.16 GHz) * `60g-2-60480-2160` - 2 (60.48/2.16 GHz) * `60g-3-62640-2160` - 3 (62.64/2.16 GHz) * `60g-4-64800-2160` - 4 (64.80/2.16 GHz) * `60g-5-66960-2160` - 5 (66.96/2.16 GHz) * `60g-6-69120-2160` - 6 (69.12/2.16 GHz) * `60g-9-59400-4320` - 9 (59.40/4.32 GHz) * `60g-10-61560-4320` - 10 (61.56/4.32 GHz) * `60g-11-63720-4320` - 11 (63.72/4.32 GHz) * `60g-12-65880-4320` - 12 (65.88/4.32 GHz) * `60g-13-68040-4320` - 13 (68.04/4.32 GHz) * `60g-17-60480-6480` - 17 (60.48/6.48 GHz) * `60g-18-62640-6480` - 18 (62.64/6.48 GHz) * `60g-19-64800-6480` - 19 (64.80/6.48 GHz) * `60g-20-66960-6480` - 20 (66.96/6.48 GHz) * `60g-25-61560-6480` - 25 (61.56/8.64 GHz) * `60g-26-63720-6480` - 26 (63.72/8.64 GHz) * `60g-27-65880-6480` - 27 (65.88/8.64 GHz)' x-spec-enum-id: 70cf66176c475063 label: type: string enum: - 1 (2412 MHz) - 2 (2417 MHz) - 3 (2422 MHz) - 4 (2427 MHz) - 5 (2432 MHz) - 6 (2437 MHz) - 7 (2442 MHz) - 8 (2447 MHz) - 9 (2452 MHz) - 10 (2457 MHz) - 11 (2462 MHz) - 12 (2467 MHz) - 13 (2472 MHz) - 32 (5160/20 MHz) - 34 (5170/40 MHz) - 36 (5180/20 MHz) - 38 (5190/40 MHz) - 40 (5200/20 MHz) - 42 (5210/80 MHz) - 44 (5220/20 MHz) - 46 (5230/40 MHz) - 48 (5240/20 MHz) - 50 (5250/160 MHz) - 52 (5260/20 MHz) - 54 (5270/40 MHz) - 56 (5280/20 MHz) - 58 (5290/80 MHz) - 60 (5300/20 MHz) - 62 (5310/40 MHz) - 64 (5320/20 MHz) - 100 (5500/20 MHz) - 102 (5510/40 MHz) - 104 (5520/20 MHz) - 106 (5530/80 MHz) - 108 (5540/20 MHz) - 110 (5550/40 MHz) - 112 (5560/20 MHz) - 114 (5570/160 MHz) - 116 (5580/20 MHz) - 118 (5590/40 MHz) - 120 (5600/20 MHz) - 122 (5610/80 MHz) - 124 (5620/20 MHz) - 126 (5630/40 MHz) - 128 (5640/20 MHz) - 132 (5660/20 MHz) - 134 (5670/40 MHz) - 136 (5680/20 MHz) - 138 (5690/80 MHz) - 140 (5700/20 MHz) - 142 (5710/40 MHz) - 144 (5720/20 MHz) - 149 (5745/20 MHz) - 151 (5755/40 MHz) - 153 (5765/20 MHz) - 155 (5775/80 MHz) - 157 (5785/20 MHz) - 159 (5795/40 MHz) - 161 (5805/20 MHz) - 163 (5815/160 MHz) - 165 (5825/20 MHz) - 167 (5835/40 MHz) - 169 (5845/20 MHz) - 171 (5855/80 MHz) - 173 (5865/20 MHz) - 175 (5875/40 MHz) - 177 (5885/20 MHz) - 1 (5955/20 MHz) - 3 (5965/40 MHz) - 5 (5975/20 MHz) - 7 (5985/80 MHz) - 9 (5995/20 MHz) - 11 (6005/40 MHz) - 13 (6015/20 MHz) - 15 (6025/160 MHz) - 17 (6035/20 MHz) - 19 (6045/40 MHz) - 21 (6055/20 MHz) - 23 (6065/80 MHz) - 25 (6075/20 MHz) - 27 (6085/40 MHz) - 29 (6095/20 MHz) - 31 (6105/320 MHz) - 33 (6115/20 MHz) - 35 (6125/40 MHz) - 37 (6135/20 MHz) - 39 (6145/80 MHz) - 41 (6155/20 MHz) - 43 (6165/40 MHz) - 45 (6175/20 MHz) - 47 (6185/160 MHz) - 49 (6195/20 MHz) - 51 (6205/40 MHz) - 53 (6215/20 MHz) - 55 (6225/80 MHz) - 57 (6235/20 MHz) - 59 (6245/40 MHz) - 61 (6255/20 MHz) - 65 (6275/20 MHz) - 67 (6285/40 MHz) - 69 (6295/20 MHz) - 71 (6305/80 MHz) - 73 (6315/20 MHz) - 75 (6325/40 MHz) - 77 (6335/20 MHz) - 79 (6345/160 MHz) - 81 (6355/20 MHz) - 83 (6365/40 MHz) - 85 (6375/20 MHz) - 87 (6385/80 MHz) - 89 (6395/20 MHz) - 91 (6405/40 MHz) - 93 (6415/20 MHz) - 95 (6425/320 MHz) - 97 (6435/20 MHz) - 99 (6445/40 MHz) - 101 (6455/20 MHz) - 103 (6465/80 MHz) - 105 (6475/20 MHz) - 107 (6485/40 MHz) - 109 (6495/20 MHz) - 111 (6505/160 MHz) - 113 (6515/20 MHz) - 115 (6525/40 MHz) - 117 (6535/20 MHz) - 119 (6545/80 MHz) - 121 (6555/20 MHz) - 123 (6565/40 MHz) - 125 (6575/20 MHz) - 129 (6595/20 MHz) - 131 (6605/40 MHz) - 133 (6615/20 MHz) - 135 (6625/80 MHz) - 137 (6635/20 MHz) - 139 (6645/40 MHz) - 141 (6655/20 MHz) - 143 (6665/160 MHz) - 145 (6675/20 MHz) - 147 (6685/40 MHz) - 149 (6695/20 MHz) - 151 (6705/80 MHz) - 153 (6715/20 MHz) - 155 (6725/40 MHz) - 157 (6735/20 MHz) - 159 (6745/320 MHz) - 161 (6755/20 MHz) - 163 (6765/40 MHz) - 165 (6775/20 MHz) - 167 (6785/80 MHz) - 169 (6795/20 MHz) - 171 (6805/40 MHz) - 173 (6815/20 MHz) - 175 (6825/160 MHz) - 177 (6835/20 MHz) - 179 (6845/40 MHz) - 181 (6855/20 MHz) - 183 (6865/80 MHz) - 185 (6875/20 MHz) - 187 (6885/40 MHz) - 189 (6895/20 MHz) - 193 (6915/20 MHz) - 195 (6925/40 MHz) - 197 (6935/20 MHz) - 199 (6945/80 MHz) - 201 (6955/20 MHz) - 203 (6965/40 MHz) - 205 (6975/20 MHz) - 207 (6985/160 MHz) - 209 (6995/20 MHz) - 211 (7005/40 MHz) - 213 (7015/20 MHz) - 215 (7025/80 MHz) - 217 (7035/20 MHz) - 219 (7045/40 MHz) - 221 (7055/20 MHz) - 225 (7075/20 MHz) - 227 (7085/40 MHz) - 229 (7095/20 MHz) - 233 (7115/20 MHz) - 1 (58.32/2.16 GHz) - 2 (60.48/2.16 GHz) - 3 (62.64/2.16 GHz) - 4 (64.80/2.16 GHz) - 5 (66.96/2.16 GHz) - 6 (69.12/2.16 GHz) - 9 (59.40/4.32 GHz) - 10 (61.56/4.32 GHz) - 11 (63.72/4.32 GHz) - 12 (65.88/4.32 GHz) - 13 (68.04/4.32 GHz) - 17 (60.48/6.48 GHz) - 18 (62.64/6.48 GHz) - 19 (64.80/6.48 GHz) - 20 (66.96/6.48 GHz) - 25 (61.56/8.64 GHz) - 26 (63.72/8.64 GHz) - 27 (65.88/8.64 GHz) poe_mode: type: object properties: value: enum: - pd - pse - '' type: string description: '* `pd` - PD * `pse` - PSE' x-spec-enum-id: 2f2fe6dcdc7772bd label: type: string enum: - PD - PSE poe_type: type: object properties: value: enum: - type1-ieee802.3af - type2-ieee802.3at - type3-ieee802.3bt - type4-ieee802.3bt - passive-24v-2pair - passive-24v-4pair - passive-48v-2pair - passive-48v-4pair - '' type: string description: '* `type1-ieee802.3af` - 802.3af (Type 1) * `type2-ieee802.3at` - 802.3at (Type 2) * `type3-ieee802.3bt` - 802.3bt (Type 3) * `type4-ieee802.3bt` - 802.3bt (Type 4) * `passive-24v-2pair` - Passive 24V (2-pair) * `passive-24v-4pair` - Passive 24V (4-pair) * `passive-48v-2pair` - Passive 48V (2-pair) * `passive-48v-4pair` - Passive 48V (4-pair)' x-spec-enum-id: 5473d57885f237ab label: type: string enum: - 802.3af (Type 1) - 802.3at (Type 2) - 802.3bt (Type 3) - 802.3bt (Type 4) - Passive 24V (2-pair) - Passive 24V (4-pair) - Passive 48V (2-pair) - Passive 48V (4-pair) rf_channel_frequency: type: number format: double maximum: 100000 minimum: -100000 exclusiveMaximum: true exclusiveMinimum: true nullable: true title: Channel frequency (MHz) description: Populated by selected channel (if set) rf_channel_width: type: number format: double maximum: 10000 minimum: -10000 exclusiveMaximum: true exclusiveMinimum: true nullable: true title: Channel width (MHz) description: Populated by selected channel (if set) tx_power: type: integer maximum: 127 minimum: -40 nullable: true title: Transmit power (dBm) untagged_vlan: allOf: - $ref: '#/components/schemas/BriefVLAN' nullable: true tagged_vlans: type: array items: $ref: '#/components/schemas/VLAN' qinq_svlan: allOf: - $ref: '#/components/schemas/BriefVLAN' nullable: true vlan_translation_policy: allOf: - $ref: '#/components/schemas/BriefVLANTranslationPolicy' nullable: true mark_connected: type: boolean description: Treat as if a cable is connected cable: allOf: - $ref: '#/components/schemas/BriefCable' readOnly: true nullable: true cable_end: type: string readOnly: true wireless_link: allOf: - $ref: '#/components/schemas/NestedWirelessLink' readOnly: true nullable: true link_peers: type: array items: {} readOnly: true link_peers_type: type: string description: Return the type of the peer link terminations, or None. readOnly: true nullable: true wireless_lans: type: array items: $ref: '#/components/schemas/WirelessLAN' vrf: allOf: - $ref: '#/components/schemas/BriefVRF' nullable: true l2vpn_termination: allOf: - $ref: '#/components/schemas/BriefL2VPNTermination' readOnly: true nullable: true connected_endpoints: type: array items: {} nullable: true readOnly: true connected_endpoints_type: type: string readOnly: true nullable: true connected_endpoints_reachable: type: boolean readOnly: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true count_ipaddresses: type: integer readOnly: true count_fhrp_groups: type: integer readOnly: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - bridge_interfaces - cable - cable_end - connected_endpoints - connected_endpoints_reachable - connected_endpoints_type - count_fhrp_groups - count_ipaddresses - created - device - display - display_url - id - l2vpn_termination - last_updated - link_peers - link_peers_type - mac_address - mac_addresses - name - type - url - wireless_link PaginatedMACAddressList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/MACAddress' ModuleTypeProfileRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 schema: nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name BriefVLANTranslationPolicy: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - name - url NestedLocationRequest: type: object 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.' properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ required: - name - slug NestedTag: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string pattern: ^[-\w]+$ maxLength: 100 color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 required: - display - display_url - id - name - slug - url BriefRackRole: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 rack_count: type: integer format: int64 readOnly: true required: - display - id - name - rack_count - slug - url PaginatedSiteGroupList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/SiteGroup' BriefInventoryItemRole: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 inventoryitem_count: type: integer format: int64 readOnly: true required: - display - id - inventoryitem_count - name - slug - url PaginatedCableTerminationList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/CableTermination' PaginatedModuleBayTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ModuleBayTemplate' InterfaceRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' vdcs: type: array items: type: integer module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - virtual - bridge - lag - 100base-fx - 100base-lfx - 100base-tx - 100base-t1 - 1000base-bx10-d - 1000base-bx10-u - 1000base-cwdm - 1000base-cx - 1000base-dwdm - 1000base-ex - 1000base-lsx - 1000base-lx - 1000base-lx10 - 1000base-sx - 1000base-t - 1000base-tx - 1000base-zx - 2.5gbase-t - 5gbase-t - 10gbase-br-d - 10gbase-br-u - 10gbase-cu - 10gbase-cx4 - 10gbase-er - 10gbase-lr - 10gbase-lrm - 10gbase-lx4 - 10gbase-sr - 10gbase-t - 10gbase-zr - 25gbase-cr - 25gbase-er - 25gbase-lr - 25gbase-sr - 25gbase-t - 40gbase-cr4 - 40gbase-er4 - 40gbase-fr4 - 40gbase-lr4 - 40gbase-sr4 - 40gbase-sr4-bd - 50gbase-cr - 50gbase-er - 50gbase-fr - 50gbase-lr - 50gbase-sr - 100gbase-cr1 - 100gbase-cr2 - 100gbase-cr4 - 100gbase-cr10 - 100gbase-cwdm4 - 100gbase-dr - 100gbase-er4 - 100gbase-fr1 - 100gbase-lr1 - 100gbase-lr4 - 100gbase-sr1 - 100gbase-sr1.2 - 100gbase-sr2 - 100gbase-sr4 - 100gbase-sr10 - 100gbase-zr - 200gbase-cr2 - 200gbase-cr4 - 200gbase-dr4 - 200gbase-er4 - 200gbase-fr4 - 200gbase-lr4 - 200gbase-sr2 - 200gbase-sr4 - 200gbase-vr2 - 400gbase-cr4 - 400gbase-dr4 - 400gbase-er8 - 400gbase-fr4 - 400gbase-fr8 - 400gbase-lr4 - 400gbase-lr8 - 400gbase-sr4 - 400gbase-sr4_2 - 400gbase-sr8 - 400gbase-sr16 - 400gbase-vr4 - 400gbase-zr - 800gbase-cr8 - 800gbase-dr8 - 800gbase-sr8 - 800gbase-vr8 - 1.6tbase-cr8 - 1.6tbase-dr8 - 1.6tbase-dr8-2 - 100base-x-sfp - 1000base-x-gbic - 1000base-x-sfp - 2.5gbase-x-sfp - 10gbase-x-sfpp - 10gbase-x-xenpak - 10gbase-x-xfp - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 50gbase-x-sfp56 - 100gbase-x-cfp - 100gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cxp - 100gbase-x-cpak - 100gbase-x-dsfp - 100gbase-x-qsfp28 - 100gbase-x-qsfpdd - 100gbase-x-sfpdd - 200gbase-x-cfp2 - 200gbase-x-qsfp56 - 200gbase-x-qsfpdd - 400gbase-x-qsfp112 - 400gbase-x-qsfpdd - 400gbase-x-cdfp - 400gbase-x-cfp2 - 400gbase-x-cfp8 - 400gbase-x-osfp - 400gbase-x-osfp-rhs - 800gbase-x-osfp - 800gbase-x-qsfpdd - 1.6tbase-x-osfp1600 - 1.6tbase-x-osfp1600-rhs - 1.6tbase-x-qsfpdd1600 - 1000base-kx - 2.5gbase-kx - 5gbase-kr - 10gbase-kr - 10gbase-kx4 - 25gbase-kr - 40gbase-kr4 - 50gbase-kr - 100gbase-kp4 - 100gbase-kr2 - 100gbase-kr4 - 1.6tbase-kr8 - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - ieee802.11ay - ieee802.11be - ieee802.15.1 - ieee802.15.4 - other-wireless - gsm - cdma - lte - 4g - 5g - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 32gfc-sfpp - 64gfc-qsfpp - 64gfc-sfpdd - 64gfc-sfpp - 128gfc-qsfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - xdsl - docsis - moca - bpon - epon - 10g-epon - gpon - xg-pon - xgs-pon - ng-pon2 - 25g-pon - 50g-pon - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - cisco-stackwise-80 - cisco-stackwise-160 - cisco-stackwise-320 - cisco-stackwise-480 - cisco-stackwise-1t - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string description: '* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) * `100base-fx` - 100BASE-FX (10/100ME) * `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) * `100base-t1` - 100BASE-T1 (10/100ME) * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) * `1000base-cwdm` - 1000BASE-CWDM (1GE) * `1000base-cx` - 1000BASE-CX (1GE DAC) * `1000base-dwdm` - 1000BASE-DWDM (1GE) * `1000base-ex` - 1000BASE-EX (1GE) * `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) * `1000base-lx10` - 1000BASE-LX10/LH (1GE) * `1000base-sx` - 1000BASE-SX (1GE) * `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) * `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) * `10gbase-er` - 10GBASE-ER (10GE) * `10gbase-lr` - 10GBASE-LR (10GE) * `10gbase-lrm` - 10GBASE-LRM (10GE) * `10gbase-lx4` - 10GBASE-LX4 (10GE) * `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) * `10gbase-zr` - 10GBASE-ZR (10GE) * `25gbase-cr` - 25GBASE-CR (25GE DAC) * `25gbase-er` - 25GBASE-ER (25GE) * `25gbase-lr` - 25GBASE-LR (25GE) * `25gbase-sr` - 25GBASE-SR (25GE) * `25gbase-t` - 25GBASE-T (25GE) * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) * `40gbase-er4` - 40GBASE-ER4 (40GE) * `40gbase-fr4` - 40GBASE-FR4 (40GE) * `40gbase-lr4` - 40GBASE-LR4 (40GE) * `40gbase-sr4` - 40GBASE-SR4 (40GE) * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) * `50gbase-cr` - 50GBASE-CR (50GE DAC) * `50gbase-er` - 50GBASE-ER (50GE) * `50gbase-fr` - 50GBASE-FR (50GE) * `50gbase-lr` - 50GBASE-LR (50GE) * `50gbase-sr` - 50GBASE-SR (50GE) * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) * `100gbase-dr` - 100GBASE-DR (100GE) * `100gbase-er4` - 100GBASE-ER4 (100GE) * `100gbase-fr1` - 100GBASE-FR1 (100GE) * `100gbase-lr1` - 100GBASE-LR1 (100GE) * `100gbase-lr4` - 100GBASE-LR4 (100GE) * `100gbase-sr1` - 100GBASE-SR1 (100GE) * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) * `100gbase-sr2` - 100GBASE-SR2 (100GE) * `100gbase-sr4` - 100GBASE-SR4 (100GE) * `100gbase-sr10` - 100GBASE-SR10 (100GE) * `100gbase-zr` - 100GBASE-ZR (100GE) * `200gbase-cr2` - 200GBASE-CR2 (200GE) * `200gbase-cr4` - 200GBASE-CR4 (200GE) * `200gbase-dr4` - 200GBASE-DR4 (200GE) * `200gbase-er4` - 200GBASE-ER4 (200GE) * `200gbase-fr4` - 200GBASE-FR4 (200GE) * `200gbase-lr4` - 200GBASE-LR4 (200GE) * `200gbase-sr2` - 200GBASE-SR2 (200GE) * `200gbase-sr4` - 200GBASE-SR4 (200GE) * `200gbase-vr2` - 200GBASE-VR2 (200GE) * `400gbase-cr4` - 400GBASE-CR4 (400GE) * `400gbase-dr4` - 400GBASE-DR4 (400GE) * `400gbase-er8` - 400GBASE-ER8 (400GE) * `400gbase-fr4` - 400GBASE-FR4 (400GE) * `400gbase-fr8` - 400GBASE-FR8 (400GE) * `400gbase-lr4` - 400GBASE-LR4 (400GE) * `400gbase-lr8` - 400GBASE-LR8 (400GE) * `400gbase-sr4` - 400GBASE-SR4 (400GE) * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) * `400gbase-sr8` - 400GBASE-SR8 (400GE) * `400gbase-sr16` - 400GBASE-SR16 (400GE) * `400gbase-vr4` - 400GBASE-VR4 (400GE) * `400gbase-zr` - 400GBASE-ZR (400GE) * `800gbase-cr8` - 800GBASE-CR8 (800GE) * `800gbase-dr8` - 800GBASE-DR8 (800GE) * `800gbase-sr8` - 800GBASE-SR8 (800GE) * `800gbase-vr8` - 800GBASE-VR8 (800GE) * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) * `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) * `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) * `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) * `100gbase-x-sfpdd` - SFP-DD (100GE) * `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) * `400gbase-x-cdfp` - CDFP (400GE) * `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) * `400gbase-x-osfp` - OSFP (400GE) * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) * `800gbase-x-qsfpdd` - QSFP-DD (800GE) * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) * `10gbase-kr` - 10GBASE-KR (10GE) * `10gbase-kx4` - 10GBASE-KX4 (10GE) * `25gbase-kr` - 25GBASE-KR (25GE) * `40gbase-kr4` - 40GBASE-KR4 (40GE) * `50gbase-kr` - 50GBASE-KR (50GE) * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) * `ieee802.11ad` - IEEE 802.11ad (WiGig) * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) * `ieee802.11ay` - IEEE 802.11ay (WiGig) * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) * `gsm` - GSM * `cdma` - CDMA * `lte` - LTE * `4g` - 4G * `5g` - 5G * `sonet-oc3` - OC-3/STM-1 * `sonet-oc12` - OC-12/STM-4 * `sonet-oc48` - OC-48/STM-16 * `sonet-oc192` - OC-192/STM-64 * `sonet-oc768` - OC-768/STM-256 * `sonet-oc1920` - OC-1920/STM-640 * `sonet-oc3840` - OC-3840/STM-1234 * `1gfc-sfp` - SFP (1GFC) * `2gfc-sfp` - SFP (2GFC) * `4gfc-sfp` - SFP (4GFC) * `8gfc-sfpp` - SFP+ (8GFC) * `16gfc-sfpp` - SFP+ (16GFC) * `32gfc-sfp28` - SFP28 (32GFC) * `32gfc-sfpp` - SFP+ (32GFC) * `64gfc-qsfpp` - QSFP+ (64GFC) * `64gfc-sfpdd` - SFP-DD (64GFC) * `64gfc-sfpp` - SFP+ (64GFC) * `128gfc-qsfp28` - QSFP28 (128GFC) * `infiniband-sdr` - SDR (2 Gbps) * `infiniband-ddr` - DDR (4 Gbps) * `infiniband-qdr` - QDR (8 Gbps) * `infiniband-fdr10` - FDR10 (10 Gbps) * `infiniband-fdr` - FDR (13.5 Gbps) * `infiniband-edr` - EDR (25 Gbps) * `infiniband-hdr` - HDR (50 Gbps) * `infiniband-ndr` - NDR (100 Gbps) * `infiniband-xdr` - XDR (250 Gbps) * `t1` - T1 (1.544 Mbps) * `e1` - E1 (2.048 Mbps) * `t3` - T3 (45 Mbps) * `e3` - E3 (34 Mbps) * `xdsl` - xDSL * `docsis` - DOCSIS * `moca` - MoCA * `bpon` - BPON (622 Mbps / 155 Mbps) * `epon` - EPON (1 Gbps) * `10g-epon` - 10G-EPON (10 Gbps) * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) * `xgs-pon` - XGS-PON (10 Gbps) * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) * `25g-pon` - 25G-PON (25 Gbps) * `50g-pon` - 50G-PON (50 Gbps) * `cisco-stackwise` - Cisco StackWise * `cisco-stackwise-plus` - Cisco StackWise Plus * `cisco-flexstack` - Cisco FlexStack * `cisco-flexstack-plus` - Cisco FlexStack Plus * `cisco-stackwise-80` - Cisco StackWise-80 * `cisco-stackwise-160` - Cisco StackWise-160 * `cisco-stackwise-320` - Cisco StackWise-320 * `cisco-stackwise-480` - Cisco StackWise-480 * `cisco-stackwise-1t` - Cisco StackWise-1T * `juniper-vcp` - Juniper VCP * `extreme-summitstack` - Extreme SummitStack * `extreme-summitstack-128` - Extreme SummitStack-128 * `extreme-summitstack-256` - Extreme SummitStack-256 * `extreme-summitstack-512` - Extreme SummitStack-512 * `other` - Other' x-spec-enum-id: b067eb1f050c6ae9 enabled: type: boolean parent: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true bridge: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true lag: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true mtu: type: integer maximum: 65536 minimum: 1 nullable: true primary_mac_address: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefMACAddressRequest' nullable: true nullable: true speed: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true title: Speed (Kbps) duplex: enum: - half - full - auto - '' - null type: string description: '* `half` - Half * `full` - Full * `auto` - Auto' x-spec-enum-id: 368458a2b67c916b nullable: true wwn: type: string nullable: true mgmt_only: type: boolean title: Management only description: This interface is used only for out-of-band management description: type: string maxLength: 200 mode: enum: - access - tagged - tagged-all - q-in-q - '' type: string description: '* `access` - Access * `tagged` - Tagged * `tagged-all` - Tagged (All) * `q-in-q` - Q-in-Q (802.1ad)' x-spec-enum-id: 84129b71b974ebe5 rf_role: enum: - ap - station - '' type: string description: '* `ap` - Access point * `station` - Station' x-spec-enum-id: d2772dbea88b0fb1 rf_channel: enum: - 2.4g-1-2412-22 - 2.4g-2-2417-22 - 2.4g-3-2422-22 - 2.4g-4-2427-22 - 2.4g-5-2432-22 - 2.4g-6-2437-22 - 2.4g-7-2442-22 - 2.4g-8-2447-22 - 2.4g-9-2452-22 - 2.4g-10-2457-22 - 2.4g-11-2462-22 - 2.4g-12-2467-22 - 2.4g-13-2472-22 - 5g-32-5160-20 - 5g-34-5170-40 - 5g-36-5180-20 - 5g-38-5190-40 - 5g-40-5200-20 - 5g-42-5210-80 - 5g-44-5220-20 - 5g-46-5230-40 - 5g-48-5240-20 - 5g-50-5250-160 - 5g-52-5260-20 - 5g-54-5270-40 - 5g-56-5280-20 - 5g-58-5290-80 - 5g-60-5300-20 - 5g-62-5310-40 - 5g-64-5320-20 - 5g-100-5500-20 - 5g-102-5510-40 - 5g-104-5520-20 - 5g-106-5530-80 - 5g-108-5540-20 - 5g-110-5550-40 - 5g-112-5560-20 - 5g-114-5570-160 - 5g-116-5580-20 - 5g-118-5590-40 - 5g-120-5600-20 - 5g-122-5610-80 - 5g-124-5620-20 - 5g-126-5630-40 - 5g-128-5640-20 - 5g-132-5660-20 - 5g-134-5670-40 - 5g-136-5680-20 - 5g-138-5690-80 - 5g-140-5700-20 - 5g-142-5710-40 - 5g-144-5720-20 - 5g-149-5745-20 - 5g-151-5755-40 - 5g-153-5765-20 - 5g-155-5775-80 - 5g-157-5785-20 - 5g-159-5795-40 - 5g-161-5805-20 - 5g-163-5815-160 - 5g-165-5825-20 - 5g-167-5835-40 - 5g-169-5845-20 - 5g-171-5855-80 - 5g-173-5865-20 - 5g-175-5875-40 - 5g-177-5885-20 - 6g-1-5955-20 - 6g-3-5965-40 - 6g-5-5975-20 - 6g-7-5985-80 - 6g-9-5995-20 - 6g-11-6005-40 - 6g-13-6015-20 - 6g-15-6025-160 - 6g-17-6035-20 - 6g-19-6045-40 - 6g-21-6055-20 - 6g-23-6065-80 - 6g-25-6075-20 - 6g-27-6085-40 - 6g-29-6095-20 - 6g-31-6105-320 - 6g-33-6115-20 - 6g-35-6125-40 - 6g-37-6135-20 - 6g-39-6145-80 - 6g-41-6155-20 - 6g-43-6165-40 - 6g-45-6175-20 - 6g-47-6185-160 - 6g-49-6195-20 - 6g-51-6205-40 - 6g-53-6215-20 - 6g-55-6225-80 - 6g-57-6235-20 - 6g-59-6245-40 - 6g-61-6255-20 - 6g-65-6275-20 - 6g-67-6285-40 - 6g-69-6295-20 - 6g-71-6305-80 - 6g-73-6315-20 - 6g-75-6325-40 - 6g-77-6335-20 - 6g-79-6345-160 - 6g-81-6355-20 - 6g-83-6365-40 - 6g-85-6375-20 - 6g-87-6385-80 - 6g-89-6395-20 - 6g-91-6405-40 - 6g-93-6415-20 - 6g-95-6425-320 - 6g-97-6435-20 - 6g-99-6445-40 - 6g-101-6455-20 - 6g-103-6465-80 - 6g-105-6475-20 - 6g-107-6485-40 - 6g-109-6495-20 - 6g-111-6505-160 - 6g-113-6515-20 - 6g-115-6525-40 - 6g-117-6535-20 - 6g-119-6545-80 - 6g-121-6555-20 - 6g-123-6565-40 - 6g-125-6575-20 - 6g-129-6595-20 - 6g-131-6605-40 - 6g-133-6615-20 - 6g-135-6625-80 - 6g-137-6635-20 - 6g-139-6645-40 - 6g-141-6655-20 - 6g-143-6665-160 - 6g-145-6675-20 - 6g-147-6685-40 - 6g-149-6695-20 - 6g-151-6705-80 - 6g-153-6715-20 - 6g-155-6725-40 - 6g-157-6735-20 - 6g-159-6745-320 - 6g-161-6755-20 - 6g-163-6765-40 - 6g-165-6775-20 - 6g-167-6785-80 - 6g-169-6795-20 - 6g-171-6805-40 - 6g-173-6815-20 - 6g-175-6825-160 - 6g-177-6835-20 - 6g-179-6845-40 - 6g-181-6855-20 - 6g-183-6865-80 - 6g-185-6875-20 - 6g-187-6885-40 - 6g-189-6895-20 - 6g-193-6915-20 - 6g-195-6925-40 - 6g-197-6935-20 - 6g-199-6945-80 - 6g-201-6955-20 - 6g-203-6965-40 - 6g-205-6975-20 - 6g-207-6985-160 - 6g-209-6995-20 - 6g-211-7005-40 - 6g-213-7015-20 - 6g-215-7025-80 - 6g-217-7035-20 - 6g-219-7045-40 - 6g-221-7055-20 - 6g-225-7075-20 - 6g-227-7085-40 - 6g-229-7095-20 - 6g-233-7115-20 - 60g-1-58320-2160 - 60g-2-60480-2160 - 60g-3-62640-2160 - 60g-4-64800-2160 - 60g-5-66960-2160 - 60g-6-69120-2160 - 60g-9-59400-4320 - 60g-10-61560-4320 - 60g-11-63720-4320 - 60g-12-65880-4320 - 60g-13-68040-4320 - 60g-17-60480-6480 - 60g-18-62640-6480 - 60g-19-64800-6480 - 60g-20-66960-6480 - 60g-25-61560-6480 - 60g-26-63720-6480 - 60g-27-65880-6480 - '' type: string description: '* `2.4g-1-2412-22` - 1 (2412 MHz) * `2.4g-2-2417-22` - 2 (2417 MHz) * `2.4g-3-2422-22` - 3 (2422 MHz) * `2.4g-4-2427-22` - 4 (2427 MHz) * `2.4g-5-2432-22` - 5 (2432 MHz) * `2.4g-6-2437-22` - 6 (2437 MHz) * `2.4g-7-2442-22` - 7 (2442 MHz) * `2.4g-8-2447-22` - 8 (2447 MHz) * `2.4g-9-2452-22` - 9 (2452 MHz) * `2.4g-10-2457-22` - 10 (2457 MHz) * `2.4g-11-2462-22` - 11 (2462 MHz) * `2.4g-12-2467-22` - 12 (2467 MHz) * `2.4g-13-2472-22` - 13 (2472 MHz) * `5g-32-5160-20` - 32 (5160/20 MHz) * `5g-34-5170-40` - 34 (5170/40 MHz) * `5g-36-5180-20` - 36 (5180/20 MHz) * `5g-38-5190-40` - 38 (5190/40 MHz) * `5g-40-5200-20` - 40 (5200/20 MHz) * `5g-42-5210-80` - 42 (5210/80 MHz) * `5g-44-5220-20` - 44 (5220/20 MHz) * `5g-46-5230-40` - 46 (5230/40 MHz) * `5g-48-5240-20` - 48 (5240/20 MHz) * `5g-50-5250-160` - 50 (5250/160 MHz) * `5g-52-5260-20` - 52 (5260/20 MHz) * `5g-54-5270-40` - 54 (5270/40 MHz) * `5g-56-5280-20` - 56 (5280/20 MHz) * `5g-58-5290-80` - 58 (5290/80 MHz) * `5g-60-5300-20` - 60 (5300/20 MHz) * `5g-62-5310-40` - 62 (5310/40 MHz) * `5g-64-5320-20` - 64 (5320/20 MHz) * `5g-100-5500-20` - 100 (5500/20 MHz) * `5g-102-5510-40` - 102 (5510/40 MHz) * `5g-104-5520-20` - 104 (5520/20 MHz) * `5g-106-5530-80` - 106 (5530/80 MHz) * `5g-108-5540-20` - 108 (5540/20 MHz) * `5g-110-5550-40` - 110 (5550/40 MHz) * `5g-112-5560-20` - 112 (5560/20 MHz) * `5g-114-5570-160` - 114 (5570/160 MHz) * `5g-116-5580-20` - 116 (5580/20 MHz) * `5g-118-5590-40` - 118 (5590/40 MHz) * `5g-120-5600-20` - 120 (5600/20 MHz) * `5g-122-5610-80` - 122 (5610/80 MHz) * `5g-124-5620-20` - 124 (5620/20 MHz) * `5g-126-5630-40` - 126 (5630/40 MHz) * `5g-128-5640-20` - 128 (5640/20 MHz) * `5g-132-5660-20` - 132 (5660/20 MHz) * `5g-134-5670-40` - 134 (5670/40 MHz) * `5g-136-5680-20` - 136 (5680/20 MHz) * `5g-138-5690-80` - 138 (5690/80 MHz) * `5g-140-5700-20` - 140 (5700/20 MHz) * `5g-142-5710-40` - 142 (5710/40 MHz) * `5g-144-5720-20` - 144 (5720/20 MHz) * `5g-149-5745-20` - 149 (5745/20 MHz) * `5g-151-5755-40` - 151 (5755/40 MHz) * `5g-153-5765-20` - 153 (5765/20 MHz) * `5g-155-5775-80` - 155 (5775/80 MHz) * `5g-157-5785-20` - 157 (5785/20 MHz) * `5g-159-5795-40` - 159 (5795/40 MHz) * `5g-161-5805-20` - 161 (5805/20 MHz) * `5g-163-5815-160` - 163 (5815/160 MHz) * `5g-165-5825-20` - 165 (5825/20 MHz) * `5g-167-5835-40` - 167 (5835/40 MHz) * `5g-169-5845-20` - 169 (5845/20 MHz) * `5g-171-5855-80` - 171 (5855/80 MHz) * `5g-173-5865-20` - 173 (5865/20 MHz) * `5g-175-5875-40` - 175 (5875/40 MHz) * `5g-177-5885-20` - 177 (5885/20 MHz) * `6g-1-5955-20` - 1 (5955/20 MHz) * `6g-3-5965-40` - 3 (5965/40 MHz) * `6g-5-5975-20` - 5 (5975/20 MHz) * `6g-7-5985-80` - 7 (5985/80 MHz) * `6g-9-5995-20` - 9 (5995/20 MHz) * `6g-11-6005-40` - 11 (6005/40 MHz) * `6g-13-6015-20` - 13 (6015/20 MHz) * `6g-15-6025-160` - 15 (6025/160 MHz) * `6g-17-6035-20` - 17 (6035/20 MHz) * `6g-19-6045-40` - 19 (6045/40 MHz) * `6g-21-6055-20` - 21 (6055/20 MHz) * `6g-23-6065-80` - 23 (6065/80 MHz) * `6g-25-6075-20` - 25 (6075/20 MHz) * `6g-27-6085-40` - 27 (6085/40 MHz) * `6g-29-6095-20` - 29 (6095/20 MHz) * `6g-31-6105-320` - 31 (6105/320 MHz) * `6g-33-6115-20` - 33 (6115/20 MHz) * `6g-35-6125-40` - 35 (6125/40 MHz) * `6g-37-6135-20` - 37 (6135/20 MHz) * `6g-39-6145-80` - 39 (6145/80 MHz) * `6g-41-6155-20` - 41 (6155/20 MHz) * `6g-43-6165-40` - 43 (6165/40 MHz) * `6g-45-6175-20` - 45 (6175/20 MHz) * `6g-47-6185-160` - 47 (6185/160 MHz) * `6g-49-6195-20` - 49 (6195/20 MHz) * `6g-51-6205-40` - 51 (6205/40 MHz) * `6g-53-6215-20` - 53 (6215/20 MHz) * `6g-55-6225-80` - 55 (6225/80 MHz) * `6g-57-6235-20` - 57 (6235/20 MHz) * `6g-59-6245-40` - 59 (6245/40 MHz) * `6g-61-6255-20` - 61 (6255/20 MHz) * `6g-65-6275-20` - 65 (6275/20 MHz) * `6g-67-6285-40` - 67 (6285/40 MHz) * `6g-69-6295-20` - 69 (6295/20 MHz) * `6g-71-6305-80` - 71 (6305/80 MHz) * `6g-73-6315-20` - 73 (6315/20 MHz) * `6g-75-6325-40` - 75 (6325/40 MHz) * `6g-77-6335-20` - 77 (6335/20 MHz) * `6g-79-6345-160` - 79 (6345/160 MHz) * `6g-81-6355-20` - 81 (6355/20 MHz) * `6g-83-6365-40` - 83 (6365/40 MHz) * `6g-85-6375-20` - 85 (6375/20 MHz) * `6g-87-6385-80` - 87 (6385/80 MHz) * `6g-89-6395-20` - 89 (6395/20 MHz) * `6g-91-6405-40` - 91 (6405/40 MHz) * `6g-93-6415-20` - 93 (6415/20 MHz) * `6g-95-6425-320` - 95 (6425/320 MHz) * `6g-97-6435-20` - 97 (6435/20 MHz) * `6g-99-6445-40` - 99 (6445/40 MHz) * `6g-101-6455-20` - 101 (6455/20 MHz) * `6g-103-6465-80` - 103 (6465/80 MHz) * `6g-105-6475-20` - 105 (6475/20 MHz) * `6g-107-6485-40` - 107 (6485/40 MHz) * `6g-109-6495-20` - 109 (6495/20 MHz) * `6g-111-6505-160` - 111 (6505/160 MHz) * `6g-113-6515-20` - 113 (6515/20 MHz) * `6g-115-6525-40` - 115 (6525/40 MHz) * `6g-117-6535-20` - 117 (6535/20 MHz) * `6g-119-6545-80` - 119 (6545/80 MHz) * `6g-121-6555-20` - 121 (6555/20 MHz) * `6g-123-6565-40` - 123 (6565/40 MHz) * `6g-125-6575-20` - 125 (6575/20 MHz) * `6g-129-6595-20` - 129 (6595/20 MHz) * `6g-131-6605-40` - 131 (6605/40 MHz) * `6g-133-6615-20` - 133 (6615/20 MHz) * `6g-135-6625-80` - 135 (6625/80 MHz) * `6g-137-6635-20` - 137 (6635/20 MHz) * `6g-139-6645-40` - 139 (6645/40 MHz) * `6g-141-6655-20` - 141 (6655/20 MHz) * `6g-143-6665-160` - 143 (6665/160 MHz) * `6g-145-6675-20` - 145 (6675/20 MHz) * `6g-147-6685-40` - 147 (6685/40 MHz) * `6g-149-6695-20` - 149 (6695/20 MHz) * `6g-151-6705-80` - 151 (6705/80 MHz) * `6g-153-6715-20` - 153 (6715/20 MHz) * `6g-155-6725-40` - 155 (6725/40 MHz) * `6g-157-6735-20` - 157 (6735/20 MHz) * `6g-159-6745-320` - 159 (6745/320 MHz) * `6g-161-6755-20` - 161 (6755/20 MHz) * `6g-163-6765-40` - 163 (6765/40 MHz) * `6g-165-6775-20` - 165 (6775/20 MHz) * `6g-167-6785-80` - 167 (6785/80 MHz) * `6g-169-6795-20` - 169 (6795/20 MHz) * `6g-171-6805-40` - 171 (6805/40 MHz) * `6g-173-6815-20` - 173 (6815/20 MHz) * `6g-175-6825-160` - 175 (6825/160 MHz) * `6g-177-6835-20` - 177 (6835/20 MHz) * `6g-179-6845-40` - 179 (6845/40 MHz) * `6g-181-6855-20` - 181 (6855/20 MHz) * `6g-183-6865-80` - 183 (6865/80 MHz) * `6g-185-6875-20` - 185 (6875/20 MHz) * `6g-187-6885-40` - 187 (6885/40 MHz) * `6g-189-6895-20` - 189 (6895/20 MHz) * `6g-193-6915-20` - 193 (6915/20 MHz) * `6g-195-6925-40` - 195 (6925/40 MHz) * `6g-197-6935-20` - 197 (6935/20 MHz) * `6g-199-6945-80` - 199 (6945/80 MHz) * `6g-201-6955-20` - 201 (6955/20 MHz) * `6g-203-6965-40` - 203 (6965/40 MHz) * `6g-205-6975-20` - 205 (6975/20 MHz) * `6g-207-6985-160` - 207 (6985/160 MHz) * `6g-209-6995-20` - 209 (6995/20 MHz) * `6g-211-7005-40` - 211 (7005/40 MHz) * `6g-213-7015-20` - 213 (7015/20 MHz) * `6g-215-7025-80` - 215 (7025/80 MHz) * `6g-217-7035-20` - 217 (7035/20 MHz) * `6g-219-7045-40` - 219 (7045/40 MHz) * `6g-221-7055-20` - 221 (7055/20 MHz) * `6g-225-7075-20` - 225 (7075/20 MHz) * `6g-227-7085-40` - 227 (7085/40 MHz) * `6g-229-7095-20` - 229 (7095/20 MHz) * `6g-233-7115-20` - 233 (7115/20 MHz) * `60g-1-58320-2160` - 1 (58.32/2.16 GHz) * `60g-2-60480-2160` - 2 (60.48/2.16 GHz) * `60g-3-62640-2160` - 3 (62.64/2.16 GHz) * `60g-4-64800-2160` - 4 (64.80/2.16 GHz) * `60g-5-66960-2160` - 5 (66.96/2.16 GHz) * `60g-6-69120-2160` - 6 (69.12/2.16 GHz) * `60g-9-59400-4320` - 9 (59.40/4.32 GHz) * `60g-10-61560-4320` - 10 (61.56/4.32 GHz) * `60g-11-63720-4320` - 11 (63.72/4.32 GHz) * `60g-12-65880-4320` - 12 (65.88/4.32 GHz) * `60g-13-68040-4320` - 13 (68.04/4.32 GHz) * `60g-17-60480-6480` - 17 (60.48/6.48 GHz) * `60g-18-62640-6480` - 18 (62.64/6.48 GHz) * `60g-19-64800-6480` - 19 (64.80/6.48 GHz) * `60g-20-66960-6480` - 20 (66.96/6.48 GHz) * `60g-25-61560-6480` - 25 (61.56/8.64 GHz) * `60g-26-63720-6480` - 26 (63.72/8.64 GHz) * `60g-27-65880-6480` - 27 (65.88/8.64 GHz)' x-spec-enum-id: 70cf66176c475063 poe_mode: enum: - pd - pse - '' type: string description: '* `pd` - PD * `pse` - PSE' x-spec-enum-id: 2f2fe6dcdc7772bd poe_type: enum: - type1-ieee802.3af - type2-ieee802.3at - type3-ieee802.3bt - type4-ieee802.3bt - passive-24v-2pair - passive-24v-4pair - passive-48v-2pair - passive-48v-4pair - '' type: string description: '* `type1-ieee802.3af` - 802.3af (Type 1) * `type2-ieee802.3at` - 802.3at (Type 2) * `type3-ieee802.3bt` - 802.3bt (Type 3) * `type4-ieee802.3bt` - 802.3bt (Type 4) * `passive-24v-2pair` - Passive 24V (2-pair) * `passive-24v-4pair` - Passive 24V (4-pair) * `passive-48v-2pair` - Passive 48V (2-pair) * `passive-48v-4pair` - Passive 48V (4-pair)' x-spec-enum-id: 5473d57885f237ab rf_channel_frequency: type: number format: double maximum: 100000 minimum: -100000 exclusiveMaximum: true exclusiveMinimum: true nullable: true title: Channel frequency (MHz) description: Populated by selected channel (if set) rf_channel_width: type: number format: double maximum: 10000 minimum: -10000 exclusiveMaximum: true exclusiveMinimum: true nullable: true title: Channel width (MHz) description: Populated by selected channel (if set) tx_power: type: integer maximum: 127 minimum: -40 nullable: true title: Transmit power (dBm) untagged_vlan: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANRequest' nullable: true nullable: true tagged_vlans: type: array items: type: integer qinq_svlan: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANRequest' nullable: true nullable: true vlan_translation_policy: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANTranslationPolicyRequest' nullable: true nullable: true mark_connected: type: boolean description: Treat as if a cable is connected wireless_lans: type: array items: type: integer vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name - type PatchedWritableConsoleServerPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' - null type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true 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' speed: enum: - 1200 - 2400 - 4800 - 9600 - 19200 - 38400 - 57600 - 115200 - null type: integer x-spec-enum-id: ab6d9635c131a378 nullable: true description: 'Port speed in bits per second * `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' minimum: 0 maximum: 2147483647 description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} SiteGroupRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ parent: allOf: - $ref: '#/components/schemas/NestedSiteGroupRequest' nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string required: - name - slug WritableCableRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: type: enum: - cat3 - cat5 - cat5e - cat6 - cat6a - cat7 - cat7a - cat8 - mrj21-trunk - dac-active - dac-passive - coaxial - rg-6 - rg-8 - rg-11 - rg-59 - rg-62 - rg-213 - lmr-100 - lmr-200 - lmr-400 - mmf - mmf-om1 - mmf-om2 - mmf-om3 - mmf-om4 - mmf-om5 - smf - smf-os1 - smf-os2 - aoc - power - usb - '' - null type: string 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' x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true a_terminations: type: array items: $ref: '#/components/schemas/GenericObjectRequest' b_terminations: type: array items: $ref: '#/components/schemas/GenericObjectRequest' status: enum: - connected - planned - decommissioning type: string description: '* `connected` - Connected * `planned` - Planned * `decommissioning` - Decommissioning' x-spec-enum-id: 80d251a40f3a3144 profile: enum: - single-1c1p - single-1c2p - single-1c4p - single-1c6p - single-1c8p - single-1c12p - single-1c16p - trunk-2c1p - trunk-2c2p - trunk-2c4p - trunk-2c4p-shuffle - trunk-2c6p - trunk-2c8p - trunk-2c12p - trunk-4c1p - trunk-4c2p - trunk-4c4p - trunk-4c4p-shuffle - trunk-4c6p - trunk-4c8p - trunk-8c4p - breakout-1c2p-2c1p - breakout-1c4p-4c1p - breakout-1c6p-6c1p - breakout-2c4p-8c1p-shuffle - '' type: string 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)' x-spec-enum-id: f566e6df6572f5d0 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true label: type: string maxLength: 100 color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 length: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true length_unit: enum: - km - m - cm - mi - ft - in - '' - null type: string description: '* `km` - Kilometers * `m` - Meters * `cm` - Centimeters * `mi` - Miles * `ft` - Feet * `in` - Inches' x-spec-enum-id: 6e7645525ba02462 nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefVLANRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string minLength: 1 maxLength: 64 description: type: string maxLength: 200 required: - name - vid BriefCable: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true label: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - url WritableConsoleServerPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' - null type: string x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true 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' speed: enum: - 1200 - 2400 - 4800 - 9600 - 19200 - 38400 - 57600 - 115200 - null type: integer x-spec-enum-id: ab6d9635c131a378 nullable: true description: 'Port speed in bits per second * `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' minimum: 0 maximum: 2147483647 description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name BriefLocationRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug PaginatedPlatformList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Platform' BriefConfigTemplate: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - name - url WritableFrontPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 rear_ports: type: array items: $ref: '#/components/schemas/FrontPortTemplateMappingRequest' description: type: string maxLength: 200 required: - name - type PatchedDeviceBayRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 description: type: string maxLength: 200 installed_device: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceRequest' nullable: true nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} DeviceWithConfigContext: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string nullable: true maxLength: 64 device_type: $ref: '#/components/schemas/BriefDeviceType' role: $ref: '#/components/schemas/BriefDeviceRole' tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true platform: allOf: - $ref: '#/components/schemas/BriefPlatform' nullable: true serial: type: string title: Serial number description: Chassis serial number, assigned by the manufacturer maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this device maxLength: 50 site: $ref: '#/components/schemas/BriefSite' location: allOf: - $ref: '#/components/schemas/BriefLocation' nullable: true rack: allOf: - $ref: '#/components/schemas/BriefRack' nullable: true position: type: number format: double maximum: 1000 minimum: 0.5 exclusiveMaximum: true nullable: true title: Position (U) face: type: object properties: value: enum: - front - rear - '' type: string description: '* `front` - Front * `rear` - Rear' x-spec-enum-id: d2fb9b3f75158b83 label: type: string enum: - Front - Rear latitude: type: number format: double maximum: 90.0 minimum: -90.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) longitude: type: number format: double maximum: 180.0 minimum: -180.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) parent_device: allOf: - $ref: '#/components/schemas/NestedDevice' nullable: true readOnly: true status: type: object properties: value: enum: - offline - active - planned - staged - failed - inventory - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `inventory` - Inventory * `decommissioning` - Decommissioning' x-spec-enum-id: 65feb4244cc9110c label: type: string enum: - Offline - Active - Planned - Staged - Failed - Inventory - Decommissioning airflow: type: object properties: value: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - rear-to-side - bottom-to-top - top-to-bottom - passive - mixed - '' type: string 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' x-spec-enum-id: 11cb3d363b41ba9e label: type: string enum: - Front to rear - Rear to front - Left to right - Right to left - Side to rear - Rear to side - Bottom to top - Top to bottom - Passive - Mixed primary_ip: allOf: - $ref: '#/components/schemas/BriefIPAddress' readOnly: true nullable: true primary_ip4: allOf: - $ref: '#/components/schemas/BriefIPAddress' nullable: true primary_ip6: allOf: - $ref: '#/components/schemas/BriefIPAddress' nullable: true oob_ip: allOf: - $ref: '#/components/schemas/BriefIPAddress' nullable: true cluster: allOf: - $ref: '#/components/schemas/BriefCluster' nullable: true virtual_chassis: allOf: - $ref: '#/components/schemas/BriefVirtualChassis' nullable: true vc_position: type: integer maximum: 255 minimum: 0 nullable: true vc_priority: type: integer maximum: 255 minimum: 0 nullable: true description: Virtual chassis master election priority description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string config_template: allOf: - $ref: '#/components/schemas/BriefConfigTemplate' nullable: true config_context: nullable: true readOnly: true local_context_data: nullable: true description: Local config context data takes precedence over source contexts in the final rendered config context tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true console_port_count: type: integer readOnly: true console_server_port_count: type: integer readOnly: true power_port_count: type: integer readOnly: true power_outlet_count: type: integer readOnly: true interface_count: type: integer readOnly: true front_port_count: type: integer readOnly: true rear_port_count: type: integer readOnly: true device_bay_count: type: integer readOnly: true module_bay_count: type: integer readOnly: true inventory_item_count: type: integer readOnly: true required: - config_context - console_port_count - console_server_port_count - created - device_bay_count - device_type - display - display_url - front_port_count - id - interface_count - inventory_item_count - last_updated - module_bay_count - parent_device - power_outlet_count - power_port_count - primary_ip - rear_port_count - role - site - url ConsoleServerPort: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' module: allOf: - $ref: '#/components/schemas/BriefModule' nullable: true name: type: string maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 label: type: string enum: - DE-9 - DB-25 - RJ-11 - RJ-12 - RJ-45 - Mini-DIN 8 - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB Micro AB - Other speed: type: object properties: value: enum: - 1200 - 2400 - 4800 - 9600 - 19200 - 38400 - 57600 - 115200 - null type: integer description: '* `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' x-spec-enum-id: ab6d9635c131a378 label: type: string enum: - 1200 bps - 2400 bps - 4800 bps - 9600 bps - 19.2 kbps - 38.4 kbps - 57.6 kbps - 115.2 kbps nullable: true description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected cable: allOf: - $ref: '#/components/schemas/BriefCable' readOnly: true nullable: true cable_end: type: string readOnly: true link_peers: type: array items: {} readOnly: true link_peers_type: type: string description: Return the type of the peer link terminations, or None. readOnly: true nullable: true connected_endpoints: type: array items: {} nullable: true readOnly: true connected_endpoints_type: type: string readOnly: true nullable: true connected_endpoints_reachable: type: boolean readOnly: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - cable - cable_end - connected_endpoints - connected_endpoints_reachable - connected_endpoints_type - created - device - display - display_url - id - last_updated - link_peers - link_peers_type - name - url PatchedWritableCableRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: type: enum: - cat3 - cat5 - cat5e - cat6 - cat6a - cat7 - cat7a - cat8 - mrj21-trunk - dac-active - dac-passive - coaxial - rg-6 - rg-8 - rg-11 - rg-59 - rg-62 - rg-213 - lmr-100 - lmr-200 - lmr-400 - mmf - mmf-om1 - mmf-om2 - mmf-om3 - mmf-om4 - mmf-om5 - smf - smf-os1 - smf-os2 - aoc - power - usb - '' - null type: string 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' x-spec-enum-id: 3d4d8d7ae24f7be8 nullable: true a_terminations: type: array items: $ref: '#/components/schemas/GenericObjectRequest' b_terminations: type: array items: $ref: '#/components/schemas/GenericObjectRequest' status: enum: - connected - planned - decommissioning type: string description: '* `connected` - Connected * `planned` - Planned * `decommissioning` - Decommissioning' x-spec-enum-id: 80d251a40f3a3144 profile: enum: - single-1c1p - single-1c2p - single-1c4p - single-1c6p - single-1c8p - single-1c12p - single-1c16p - trunk-2c1p - trunk-2c2p - trunk-2c4p - trunk-2c4p-shuffle - trunk-2c6p - trunk-2c8p - trunk-2c12p - trunk-4c1p - trunk-4c2p - trunk-4c4p - trunk-4c4p-shuffle - trunk-4c6p - trunk-4c8p - trunk-8c4p - breakout-1c2p-2c1p - breakout-1c4p-4c1p - breakout-1c6p-6c1p - breakout-2c4p-8c1p-shuffle - '' type: string 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)' x-spec-enum-id: f566e6df6572f5d0 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true label: type: string maxLength: 100 color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 length: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true length_unit: enum: - km - m - cm - mi - ft - in - '' - null type: string description: '* `km` - Kilometers * `m` - Meters * `cm` - Centimeters * `mi` - Miles * `ft` - Feet * `in` - Inches' x-spec-enum-id: 6e7645525ba02462 nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} NestedDevice: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string nullable: true maxLength: 64 required: - display - display_url - id - url DeviceBayTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceTypeRequest' name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 description: type: string maxLength: 200 required: - device_type - name PaginatedPowerFeedList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/PowerFeed' Region: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ parent: allOf: - $ref: '#/components/schemas/NestedRegion' nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true site_count: type: integer readOnly: true default: 0 prefix_count: type: integer format: int64 readOnly: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string _depth: type: integer readOnly: true title: ' depth' required: - _depth - created - display - display_url - id - last_updated - name - prefix_count - site_count - slug - url PatchedWritableInventoryItemRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' parent: type: integer nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 status: enum: - offline - active - planned - staged - failed - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning' x-spec-enum-id: 545817eb4c4f2ae4 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefInventoryItemRoleRequest' nullable: true nullable: true manufacturer: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefManufacturerRequest' nullable: true nullable: true part_id: type: string description: Manufacturer-assigned part identifier maxLength: 50 serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this item maxLength: 50 discovered: type: boolean description: This item was automatically discovered description: type: string maxLength: 200 component_type: type: string nullable: true component_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefOwner: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - name - url WritableSiteRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 description: Full name of the site maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ status: enum: - planned - staging - active - decommissioning - retired type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `retired` - Retired' x-spec-enum-id: 1cf60831fbb35e7f region: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRegionRequest' nullable: true nullable: true group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefSiteGroupRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true facility: type: string description: Local facility ID or description maxLength: 50 time_zone: type: string nullable: true minLength: 1 description: type: string maxLength: 200 physical_address: type: string description: Physical location of the building maxLength: 200 shipping_address: type: string description: If different from the physical address maxLength: 200 latitude: type: number format: double maximum: 90.0 minimum: -90.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) longitude: type: number format: double maximum: 180.0 minimum: -180.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string asns: type: array items: type: integer tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug BriefPowerPort: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' name: type: string maxLength: 64 description: type: string maxLength: 200 cable: allOf: - $ref: '#/components/schemas/BriefCable' readOnly: true nullable: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - cable - device - display - id - name - url BriefIPAddress: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true family: type: object properties: value: enum: - 4 - 6 type: integer description: '* `4` - IPv4 * `6` - IPv6' x-spec-enum-id: d72003fd1af3603d label: type: string enum: - IPv4 - IPv6 readOnly: true address: type: string description: type: string maxLength: 200 required: - address - display - family - id - url PaginatedFrontPortTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/FrontPortTemplate' WritableSiteGroupRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ parent: type: integer nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string required: - name - slug BriefSite: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string description: Full name of the site maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - display - id - name - slug - url PatchedWritableRegionRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ parent: type: integer nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string PaginatedModuleBayList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ModuleBay' BriefRegionRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug PatchedWritableInterfaceTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - virtual - bridge - lag - 100base-fx - 100base-lfx - 100base-tx - 100base-t1 - 1000base-bx10-d - 1000base-bx10-u - 1000base-cwdm - 1000base-cx - 1000base-dwdm - 1000base-ex - 1000base-lsx - 1000base-lx - 1000base-lx10 - 1000base-sx - 1000base-t - 1000base-tx - 1000base-zx - 2.5gbase-t - 5gbase-t - 10gbase-br-d - 10gbase-br-u - 10gbase-cu - 10gbase-cx4 - 10gbase-er - 10gbase-lr - 10gbase-lrm - 10gbase-lx4 - 10gbase-sr - 10gbase-t - 10gbase-zr - 25gbase-cr - 25gbase-er - 25gbase-lr - 25gbase-sr - 25gbase-t - 40gbase-cr4 - 40gbase-er4 - 40gbase-fr4 - 40gbase-lr4 - 40gbase-sr4 - 40gbase-sr4-bd - 50gbase-cr - 50gbase-er - 50gbase-fr - 50gbase-lr - 50gbase-sr - 100gbase-cr1 - 100gbase-cr2 - 100gbase-cr4 - 100gbase-cr10 - 100gbase-cwdm4 - 100gbase-dr - 100gbase-er4 - 100gbase-fr1 - 100gbase-lr1 - 100gbase-lr4 - 100gbase-sr1 - 100gbase-sr1.2 - 100gbase-sr2 - 100gbase-sr4 - 100gbase-sr10 - 100gbase-zr - 200gbase-cr2 - 200gbase-cr4 - 200gbase-dr4 - 200gbase-er4 - 200gbase-fr4 - 200gbase-lr4 - 200gbase-sr2 - 200gbase-sr4 - 200gbase-vr2 - 400gbase-cr4 - 400gbase-dr4 - 400gbase-er8 - 400gbase-fr4 - 400gbase-fr8 - 400gbase-lr4 - 400gbase-lr8 - 400gbase-sr4 - 400gbase-sr4_2 - 400gbase-sr8 - 400gbase-sr16 - 400gbase-vr4 - 400gbase-zr - 800gbase-cr8 - 800gbase-dr8 - 800gbase-sr8 - 800gbase-vr8 - 1.6tbase-cr8 - 1.6tbase-dr8 - 1.6tbase-dr8-2 - 100base-x-sfp - 1000base-x-gbic - 1000base-x-sfp - 2.5gbase-x-sfp - 10gbase-x-sfpp - 10gbase-x-xenpak - 10gbase-x-xfp - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 50gbase-x-sfp56 - 100gbase-x-cfp - 100gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cxp - 100gbase-x-cpak - 100gbase-x-dsfp - 100gbase-x-qsfp28 - 100gbase-x-qsfpdd - 100gbase-x-sfpdd - 200gbase-x-cfp2 - 200gbase-x-qsfp56 - 200gbase-x-qsfpdd - 400gbase-x-qsfp112 - 400gbase-x-qsfpdd - 400gbase-x-cdfp - 400gbase-x-cfp2 - 400gbase-x-cfp8 - 400gbase-x-osfp - 400gbase-x-osfp-rhs - 800gbase-x-osfp - 800gbase-x-qsfpdd - 1.6tbase-x-osfp1600 - 1.6tbase-x-osfp1600-rhs - 1.6tbase-x-qsfpdd1600 - 1000base-kx - 2.5gbase-kx - 5gbase-kr - 10gbase-kr - 10gbase-kx4 - 25gbase-kr - 40gbase-kr4 - 50gbase-kr - 100gbase-kp4 - 100gbase-kr2 - 100gbase-kr4 - 1.6tbase-kr8 - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - ieee802.11ay - ieee802.11be - ieee802.15.1 - ieee802.15.4 - other-wireless - gsm - cdma - lte - 4g - 5g - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 32gfc-sfpp - 64gfc-qsfpp - 64gfc-sfpdd - 64gfc-sfpp - 128gfc-qsfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - xdsl - docsis - moca - bpon - epon - 10g-epon - gpon - xg-pon - xgs-pon - ng-pon2 - 25g-pon - 50g-pon - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - cisco-stackwise-80 - cisco-stackwise-160 - cisco-stackwise-320 - cisco-stackwise-480 - cisco-stackwise-1t - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string description: '* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) * `100base-fx` - 100BASE-FX (10/100ME) * `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) * `100base-t1` - 100BASE-T1 (10/100ME) * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) * `1000base-cwdm` - 1000BASE-CWDM (1GE) * `1000base-cx` - 1000BASE-CX (1GE DAC) * `1000base-dwdm` - 1000BASE-DWDM (1GE) * `1000base-ex` - 1000BASE-EX (1GE) * `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) * `1000base-lx10` - 1000BASE-LX10/LH (1GE) * `1000base-sx` - 1000BASE-SX (1GE) * `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) * `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) * `10gbase-er` - 10GBASE-ER (10GE) * `10gbase-lr` - 10GBASE-LR (10GE) * `10gbase-lrm` - 10GBASE-LRM (10GE) * `10gbase-lx4` - 10GBASE-LX4 (10GE) * `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) * `10gbase-zr` - 10GBASE-ZR (10GE) * `25gbase-cr` - 25GBASE-CR (25GE DAC) * `25gbase-er` - 25GBASE-ER (25GE) * `25gbase-lr` - 25GBASE-LR (25GE) * `25gbase-sr` - 25GBASE-SR (25GE) * `25gbase-t` - 25GBASE-T (25GE) * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) * `40gbase-er4` - 40GBASE-ER4 (40GE) * `40gbase-fr4` - 40GBASE-FR4 (40GE) * `40gbase-lr4` - 40GBASE-LR4 (40GE) * `40gbase-sr4` - 40GBASE-SR4 (40GE) * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) * `50gbase-cr` - 50GBASE-CR (50GE DAC) * `50gbase-er` - 50GBASE-ER (50GE) * `50gbase-fr` - 50GBASE-FR (50GE) * `50gbase-lr` - 50GBASE-LR (50GE) * `50gbase-sr` - 50GBASE-SR (50GE) * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) * `100gbase-dr` - 100GBASE-DR (100GE) * `100gbase-er4` - 100GBASE-ER4 (100GE) * `100gbase-fr1` - 100GBASE-FR1 (100GE) * `100gbase-lr1` - 100GBASE-LR1 (100GE) * `100gbase-lr4` - 100GBASE-LR4 (100GE) * `100gbase-sr1` - 100GBASE-SR1 (100GE) * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) * `100gbase-sr2` - 100GBASE-SR2 (100GE) * `100gbase-sr4` - 100GBASE-SR4 (100GE) * `100gbase-sr10` - 100GBASE-SR10 (100GE) * `100gbase-zr` - 100GBASE-ZR (100GE) * `200gbase-cr2` - 200GBASE-CR2 (200GE) * `200gbase-cr4` - 200GBASE-CR4 (200GE) * `200gbase-dr4` - 200GBASE-DR4 (200GE) * `200gbase-er4` - 200GBASE-ER4 (200GE) * `200gbase-fr4` - 200GBASE-FR4 (200GE) * `200gbase-lr4` - 200GBASE-LR4 (200GE) * `200gbase-sr2` - 200GBASE-SR2 (200GE) * `200gbase-sr4` - 200GBASE-SR4 (200GE) * `200gbase-vr2` - 200GBASE-VR2 (200GE) * `400gbase-cr4` - 400GBASE-CR4 (400GE) * `400gbase-dr4` - 400GBASE-DR4 (400GE) * `400gbase-er8` - 400GBASE-ER8 (400GE) * `400gbase-fr4` - 400GBASE-FR4 (400GE) * `400gbase-fr8` - 400GBASE-FR8 (400GE) * `400gbase-lr4` - 400GBASE-LR4 (400GE) * `400gbase-lr8` - 400GBASE-LR8 (400GE) * `400gbase-sr4` - 400GBASE-SR4 (400GE) * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) * `400gbase-sr8` - 400GBASE-SR8 (400GE) * `400gbase-sr16` - 400GBASE-SR16 (400GE) * `400gbase-vr4` - 400GBASE-VR4 (400GE) * `400gbase-zr` - 400GBASE-ZR (400GE) * `800gbase-cr8` - 800GBASE-CR8 (800GE) * `800gbase-dr8` - 800GBASE-DR8 (800GE) * `800gbase-sr8` - 800GBASE-SR8 (800GE) * `800gbase-vr8` - 800GBASE-VR8 (800GE) * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) * `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) * `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) * `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) * `100gbase-x-sfpdd` - SFP-DD (100GE) * `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) * `400gbase-x-cdfp` - CDFP (400GE) * `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) * `400gbase-x-osfp` - OSFP (400GE) * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) * `800gbase-x-qsfpdd` - QSFP-DD (800GE) * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) * `10gbase-kr` - 10GBASE-KR (10GE) * `10gbase-kx4` - 10GBASE-KX4 (10GE) * `25gbase-kr` - 25GBASE-KR (25GE) * `40gbase-kr4` - 40GBASE-KR4 (40GE) * `50gbase-kr` - 50GBASE-KR (50GE) * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) * `ieee802.11ad` - IEEE 802.11ad (WiGig) * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) * `ieee802.11ay` - IEEE 802.11ay (WiGig) * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) * `gsm` - GSM * `cdma` - CDMA * `lte` - LTE * `4g` - 4G * `5g` - 5G * `sonet-oc3` - OC-3/STM-1 * `sonet-oc12` - OC-12/STM-4 * `sonet-oc48` - OC-48/STM-16 * `sonet-oc192` - OC-192/STM-64 * `sonet-oc768` - OC-768/STM-256 * `sonet-oc1920` - OC-1920/STM-640 * `sonet-oc3840` - OC-3840/STM-1234 * `1gfc-sfp` - SFP (1GFC) * `2gfc-sfp` - SFP (2GFC) * `4gfc-sfp` - SFP (4GFC) * `8gfc-sfpp` - SFP+ (8GFC) * `16gfc-sfpp` - SFP+ (16GFC) * `32gfc-sfp28` - SFP28 (32GFC) * `32gfc-sfpp` - SFP+ (32GFC) * `64gfc-qsfpp` - QSFP+ (64GFC) * `64gfc-sfpdd` - SFP-DD (64GFC) * `64gfc-sfpp` - SFP+ (64GFC) * `128gfc-qsfp28` - QSFP28 (128GFC) * `infiniband-sdr` - SDR (2 Gbps) * `infiniband-ddr` - DDR (4 Gbps) * `infiniband-qdr` - QDR (8 Gbps) * `infiniband-fdr10` - FDR10 (10 Gbps) * `infiniband-fdr` - FDR (13.5 Gbps) * `infiniband-edr` - EDR (25 Gbps) * `infiniband-hdr` - HDR (50 Gbps) * `infiniband-ndr` - NDR (100 Gbps) * `infiniband-xdr` - XDR (250 Gbps) * `t1` - T1 (1.544 Mbps) * `e1` - E1 (2.048 Mbps) * `t3` - T3 (45 Mbps) * `e3` - E3 (34 Mbps) * `xdsl` - xDSL * `docsis` - DOCSIS * `moca` - MoCA * `bpon` - BPON (622 Mbps / 155 Mbps) * `epon` - EPON (1 Gbps) * `10g-epon` - 10G-EPON (10 Gbps) * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) * `xgs-pon` - XGS-PON (10 Gbps) * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) * `25g-pon` - 25G-PON (25 Gbps) * `50g-pon` - 50G-PON (50 Gbps) * `cisco-stackwise` - Cisco StackWise * `cisco-stackwise-plus` - Cisco StackWise Plus * `cisco-flexstack` - Cisco FlexStack * `cisco-flexstack-plus` - Cisco FlexStack Plus * `cisco-stackwise-80` - Cisco StackWise-80 * `cisco-stackwise-160` - Cisco StackWise-160 * `cisco-stackwise-320` - Cisco StackWise-320 * `cisco-stackwise-480` - Cisco StackWise-480 * `cisco-stackwise-1t` - Cisco StackWise-1T * `juniper-vcp` - Juniper VCP * `extreme-summitstack` - Extreme SummitStack * `extreme-summitstack-128` - Extreme SummitStack-128 * `extreme-summitstack-256` - Extreme SummitStack-256 * `extreme-summitstack-512` - Extreme SummitStack-512 * `other` - Other' x-spec-enum-id: b067eb1f050c6ae9 enabled: type: boolean mgmt_only: type: boolean title: Management only description: type: string maxLength: 200 bridge: type: integer nullable: true title: Bridge interface poe_mode: enum: - pd - pse - '' - null type: string description: '* `pd` - PD * `pse` - PSE' x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true poe_type: enum: - type1-ieee802.3af - type2-ieee802.3at - type3-ieee802.3bt - type4-ieee802.3bt - passive-24v-2pair - passive-24v-4pair - passive-48v-2pair - passive-48v-4pair - '' - null type: string description: '* `type1-ieee802.3af` - 802.3af (Type 1) * `type2-ieee802.3at` - 802.3at (Type 2) * `type3-ieee802.3bt` - 802.3bt (Type 3) * `type4-ieee802.3bt` - 802.3bt (Type 4) * `passive-24v-2pair` - Passive 24V (2-pair) * `passive-24v-4pair` - Passive 24V (4-pair) * `passive-48v-2pair` - Passive 48V (2-pair) * `passive-48v-4pair` - Passive 48V (4-pair)' x-spec-enum-id: 5473d57885f237ab nullable: true rf_role: enum: - ap - station - '' - null type: string description: '* `ap` - Access point * `station` - Station' x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role PatchedWritablePowerOutletTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c5 - iec-60320-c7 - iec-60320-c13 - iec-60320-c15 - iec-60320-c17 - iec-60320-c19 - iec-60320-c21 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15r - nema-5-15r - nema-5-20r - nema-5-30r - nema-5-50r - nema-6-15r - nema-6-20r - nema-6-30r - nema-6-50r - nema-10-30r - nema-10-50r - nema-14-20r - nema-14-30r - nema-14-50r - nema-14-60r - nema-15-15r - nema-15-20r - nema-15-30r - nema-15-50r - nema-15-60r - nema-l1-15r - nema-l5-15r - nema-l5-20r - nema-l5-30r - nema-l5-50r - nema-l6-15r - nema-l6-20r - nema-l6-30r - nema-l6-50r - nema-l10-30r - nema-l14-20r - nema-l14-30r - nema-l14-50r - nema-l14-60r - nema-l15-20r - nema-l15-30r - nema-l15-50r - nema-l15-60r - nema-l21-20r - nema-l21-30r - nema-l22-20r - nema-l22-30r - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ita-e - ita-f - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - ita-multistandard - usb-a - usb-micro-b - usb-c - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - eaton-c39 - hdot-cx - saf-d-grid - neutrik-powercon-20a - neutrik-powercon-32a - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c5` - C5 * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 * `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15r` - NEMA 1-15R * `nema-5-15r` - NEMA 5-15R * `nema-5-20r` - NEMA 5-20R * `nema-5-30r` - NEMA 5-30R * `nema-5-50r` - NEMA 5-50R * `nema-6-15r` - NEMA 6-15R * `nema-6-20r` - NEMA 6-20R * `nema-6-30r` - NEMA 6-30R * `nema-6-50r` - NEMA 6-50R * `nema-10-30r` - NEMA 10-30R * `nema-10-50r` - NEMA 10-50R * `nema-14-20r` - NEMA 14-20R * `nema-14-30r` - NEMA 14-30R * `nema-14-50r` - NEMA 14-50R * `nema-14-60r` - NEMA 14-60R * `nema-15-15r` - NEMA 15-15R * `nema-15-20r` - NEMA 15-20R * `nema-15-30r` - NEMA 15-30R * `nema-15-50r` - NEMA 15-50R * `nema-15-60r` - NEMA 15-60R * `nema-l1-15r` - NEMA L1-15R * `nema-l5-15r` - NEMA L5-15R * `nema-l5-20r` - NEMA L5-20R * `nema-l5-30r` - NEMA L5-30R * `nema-l5-50r` - NEMA L5-50R * `nema-l6-15r` - NEMA L6-15R * `nema-l6-20r` - NEMA L6-20R * `nema-l6-30r` - NEMA L6-30R * `nema-l6-50r` - NEMA L6-50R * `nema-l10-30r` - NEMA L10-30R * `nema-l14-20r` - NEMA L14-20R * `nema-l14-30r` - NEMA L14-30R * `nema-l14-50r` - NEMA L14-50R * `nema-l14-60r` - NEMA L14-60R * `nema-l15-20r` - NEMA L15-20R * `nema-l15-30r` - NEMA L15-30R * `nema-l15-50r` - NEMA L15-50R * `nema-l15-60r` - NEMA L15-60R * `nema-l21-20r` - NEMA L21-20R * `nema-l21-30r` - NEMA L21-30R * `nema-l22-20r` - NEMA L22-20R * `nema-l22-30r` - NEMA L22-30R * `CS6360C` - CS6360C * `CS6364C` - CS6364C * `CS8164C` - CS8164C * `CS8264C` - CS8264C * `CS8364C` - CS8364C * `CS8464C` - CS8464C * `ita-e` - ITA Type E (CEE 7/5) * `ita-f` - ITA Type F (CEE 7/3) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `ita-multistandard` - ITA Multistandard * `usb-a` - USB Type A * `usb-micro-b` - USB Micro B * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 * `hdot-cx` - HDOT Cx * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20a` - Neutrik powerCON (20A) * `neutrik-powercon-32a` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: db3e4eb2b93615f8 nullable: true color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 power_port: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPowerPortTemplateRequest' nullable: true nullable: true feed_leg: enum: - A - B - C - '' - null type: string x-spec-enum-id: a4902339df0b7c06 nullable: true description: 'Phase (for three-phase feeds) * `A` - A * `B` - B * `C` - C' description: type: string maxLength: 200 PaginatedFrontPortList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/FrontPort' ConsoleServerPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 description: type: string maxLength: 200 required: - name ModuleRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module_bay: $ref: '#/components/schemas/NestedModuleBayRequest' module_type: oneOf: - type: integer - $ref: '#/components/schemas/BriefModuleTypeRequest' status: enum: - offline - active - planned - staged - failed - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning' x-spec-enum-id: 545817eb4c4f2ae4 serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this device maxLength: 50 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - module_bay - module_type PaginatedDeviceBayList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DeviceBay' BriefRegion: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 site_count: type: integer readOnly: true default: 0 _depth: type: integer readOnly: true title: ' depth' required: - _depth - display - id - name - site_count - slug - url WritableLocationRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ site: oneOf: - type: integer - $ref: '#/components/schemas/BriefSiteRequest' parent: type: integer nullable: true status: enum: - planned - staging - active - decommissioning - retired type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `retired` - Retired' x-spec-enum-id: 1cf60831fbb35e7f tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true facility: type: string description: Local facility ID or description maxLength: 50 description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string required: - name - site - slug NestedInterfaceTemplateRequest: type: object 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.' properties: name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 required: - name PaginatedInterfaceTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/InterfaceTemplate' WritableVirtualChassisRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 64 domain: type: string maxLength: 30 master: type: integer nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name NestedPlatformRequest: type: object 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.' properties: name: type: string minLength: 1 maxLength: 100 required: - name Device: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string nullable: true maxLength: 64 device_type: $ref: '#/components/schemas/BriefDeviceType' role: $ref: '#/components/schemas/BriefDeviceRole' tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true platform: allOf: - $ref: '#/components/schemas/BriefPlatform' nullable: true serial: type: string title: Serial number description: Chassis serial number, assigned by the manufacturer maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this device maxLength: 50 site: $ref: '#/components/schemas/BriefSite' location: allOf: - $ref: '#/components/schemas/BriefLocation' nullable: true rack: allOf: - $ref: '#/components/schemas/BriefRack' nullable: true position: type: number format: double maximum: 1000 minimum: 0.5 exclusiveMaximum: true nullable: true title: Position (U) face: type: object properties: value: enum: - front - rear - '' type: string description: '* `front` - Front * `rear` - Rear' x-spec-enum-id: d2fb9b3f75158b83 label: type: string enum: - Front - Rear latitude: type: number format: double maximum: 90.0 minimum: -90.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) longitude: type: number format: double maximum: 180.0 minimum: -180.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) parent_device: allOf: - $ref: '#/components/schemas/NestedDevice' nullable: true readOnly: true status: type: object properties: value: enum: - offline - active - planned - staged - failed - inventory - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `inventory` - Inventory * `decommissioning` - Decommissioning' x-spec-enum-id: 65feb4244cc9110c label: type: string enum: - Offline - Active - Planned - Staged - Failed - Inventory - Decommissioning airflow: type: object properties: value: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - rear-to-side - bottom-to-top - top-to-bottom - passive - mixed - '' type: string 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' x-spec-enum-id: 11cb3d363b41ba9e label: type: string enum: - Front to rear - Rear to front - Left to right - Right to left - Side to rear - Rear to side - Bottom to top - Top to bottom - Passive - Mixed primary_ip: allOf: - $ref: '#/components/schemas/BriefIPAddress' readOnly: true nullable: true primary_ip4: allOf: - $ref: '#/components/schemas/BriefIPAddress' nullable: true primary_ip6: allOf: - $ref: '#/components/schemas/BriefIPAddress' nullable: true oob_ip: allOf: - $ref: '#/components/schemas/BriefIPAddress' nullable: true cluster: allOf: - $ref: '#/components/schemas/BriefCluster' nullable: true virtual_chassis: allOf: - $ref: '#/components/schemas/BriefVirtualChassis' nullable: true vc_position: type: integer maximum: 255 minimum: 0 nullable: true vc_priority: type: integer maximum: 255 minimum: 0 nullable: true description: Virtual chassis master election priority description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string config_template: allOf: - $ref: '#/components/schemas/BriefConfigTemplate' nullable: true local_context_data: nullable: true description: Local config context data takes precedence over source contexts in the final rendered config context tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true console_port_count: type: integer readOnly: true console_server_port_count: type: integer readOnly: true power_port_count: type: integer readOnly: true power_outlet_count: type: integer readOnly: true interface_count: type: integer readOnly: true front_port_count: type: integer readOnly: true rear_port_count: type: integer readOnly: true device_bay_count: type: integer readOnly: true module_bay_count: type: integer readOnly: true inventory_item_count: type: integer readOnly: true required: - console_port_count - console_server_port_count - created - device_bay_count - device_type - display - display_url - front_port_count - id - interface_count - inventory_item_count - last_updated - module_bay_count - parent_device - power_outlet_count - power_port_count - primary_ip - rear_port_count - role - site - url BriefVirtualChassis: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 64 master: allOf: - $ref: '#/components/schemas/NestedDevice' nullable: true description: type: string maxLength: 200 member_count: type: integer readOnly: true required: - display - id - member_count - name - url BriefPowerPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' name: type: string minLength: 1 maxLength: 64 description: type: string maxLength: 200 required: - device - name WritablePowerPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c6 - iec-60320-c8 - iec-60320-c14 - iec-60320-c16 - iec-60320-c18 - iec-60320-c20 - iec-60320-c22 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15p - nema-5-15p - nema-5-20p - nema-5-30p - nema-5-50p - nema-6-15p - nema-6-20p - nema-6-30p - nema-6-50p - nema-10-30p - nema-10-50p - nema-14-20p - nema-14-30p - nema-14-50p - nema-14-60p - nema-15-15p - nema-15-20p - nema-15-30p - nema-15-50p - nema-15-60p - nema-l1-15p - nema-l5-15p - nema-l5-20p - nema-l5-30p - nema-l5-50p - nema-l6-15p - nema-l6-20p - nema-l6-30p - nema-l6-50p - nema-l10-30p - nema-l14-20p - nema-l14-30p - nema-l14-50p - nema-l14-60p - nema-l15-20p - nema-l15-30p - nema-l15-50p - nema-l15-60p - nema-l21-20p - nema-l21-30p - nema-l22-20p - nema-l22-30p - cs6361c - cs6365c - cs8165c - cs8265c - cs8365c - cs8465c - ita-c - ita-e - ita-f - ita-ef - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - usb-3-b - usb-3-micro-b - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - saf-d-grid - neutrik-powercon-20 - neutrik-powercon-32 - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c6` - C6 * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 * `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15p` - NEMA 1-15P * `nema-5-15p` - NEMA 5-15P * `nema-5-20p` - NEMA 5-20P * `nema-5-30p` - NEMA 5-30P * `nema-5-50p` - NEMA 5-50P * `nema-6-15p` - NEMA 6-15P * `nema-6-20p` - NEMA 6-20P * `nema-6-30p` - NEMA 6-30P * `nema-6-50p` - NEMA 6-50P * `nema-10-30p` - NEMA 10-30P * `nema-10-50p` - NEMA 10-50P * `nema-14-20p` - NEMA 14-20P * `nema-14-30p` - NEMA 14-30P * `nema-14-50p` - NEMA 14-50P * `nema-14-60p` - NEMA 14-60P * `nema-15-15p` - NEMA 15-15P * `nema-15-20p` - NEMA 15-20P * `nema-15-30p` - NEMA 15-30P * `nema-15-50p` - NEMA 15-50P * `nema-15-60p` - NEMA 15-60P * `nema-l1-15p` - NEMA L1-15P * `nema-l5-15p` - NEMA L5-15P * `nema-l5-20p` - NEMA L5-20P * `nema-l5-30p` - NEMA L5-30P * `nema-l5-50p` - NEMA L5-50P * `nema-l6-15p` - NEMA L6-15P * `nema-l6-20p` - NEMA L6-20P * `nema-l6-30p` - NEMA L6-30P * `nema-l6-50p` - NEMA L6-50P * `nema-l10-30p` - NEMA L10-30P * `nema-l14-20p` - NEMA L14-20P * `nema-l14-30p` - NEMA L14-30P * `nema-l14-50p` - NEMA L14-50P * `nema-l14-60p` - NEMA L14-60P * `nema-l15-20p` - NEMA L15-20P * `nema-l15-30p` - NEMA L15-30P * `nema-l15-50p` - NEMA L15-50P * `nema-l15-60p` - NEMA L15-60P * `nema-l21-20p` - NEMA L21-20P * `nema-l21-30p` - NEMA L21-30P * `nema-l22-20p` - NEMA L22-20P * `nema-l22-30p` - NEMA L22-30P * `cs6361c` - CS6361C * `cs6365c` - CS6365C * `cs8165c` - CS8165C * `cs8265c` - CS8265C * `cs8365c` - CS8365C * `cs8465c` - CS8465C * `ita-c` - ITA Type C (CEE 7/16) * `ita-e` - ITA Type E (CEE 7/6) * `ita-f` - ITA Type F (CEE 7/4) * `ita-ef` - ITA Type E/F (CEE 7/7) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `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 * `usb-3-b` - USB 3.0 Type B * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20` - Neutrik powerCON (20A) * `neutrik-powercon-32` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: aadcbe6ca854c1ed nullable: true maximum_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Maximum power draw (watts) allocated_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Allocated power draw (watts) description: type: string maxLength: 200 required: - name PatchedWritableDeviceRoleRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string minLength: 1 pattern: ^[0-9a-f]{6}$ maxLength: 6 vm_role: type: boolean description: Virtual machines may be assigned to this role config_template: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefConfigTemplateRequest' nullable: true nullable: true parent: type: integer nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string DeviceBayRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 description: type: string maxLength: 200 installed_device: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceRequest' nullable: true nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name BriefModuleTypeProfile: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - name - url BriefDevice: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string nullable: true maxLength: 64 description: type: string maxLength: 200 required: - display - id - url DeviceWithConfigContextRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string nullable: true maxLength: 64 device_type: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceTypeRequest' role: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRoleRequest' tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true platform: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPlatformRequest' nullable: true nullable: true serial: type: string title: Serial number description: Chassis serial number, assigned by the manufacturer maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this device maxLength: 50 site: oneOf: - type: integer - $ref: '#/components/schemas/BriefSiteRequest' location: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefLocationRequest' nullable: true nullable: true rack: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackRequest' nullable: true nullable: true position: type: number format: double maximum: 1000 minimum: 0.5 exclusiveMaximum: true nullable: true title: Position (U) face: enum: - front - rear - '' type: string description: '* `front` - Front * `rear` - Rear' x-spec-enum-id: d2fb9b3f75158b83 latitude: type: number format: double maximum: 90.0 minimum: -90.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) longitude: type: number format: double maximum: 180.0 minimum: -180.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) status: enum: - offline - active - planned - staged - failed - inventory - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `inventory` - Inventory * `decommissioning` - Decommissioning' x-spec-enum-id: 65feb4244cc9110c airflow: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - rear-to-side - bottom-to-top - top-to-bottom - passive - mixed - '' type: string 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' x-spec-enum-id: 11cb3d363b41ba9e primary_ip4: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true primary_ip6: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true oob_ip: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true cluster: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefClusterRequest' nullable: true nullable: true virtual_chassis: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVirtualChassisRequest' nullable: true nullable: true vc_position: type: integer maximum: 255 minimum: 0 nullable: true vc_priority: type: integer maximum: 255 minimum: 0 nullable: true description: Virtual chassis master election priority description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string config_template: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefConfigTemplateRequest' nullable: true nullable: true local_context_data: nullable: true description: Local config context data takes precedence over source contexts in the final rendered config context tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device_type - role - site PatchedWritableConsolePortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' - null type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: type: string maxLength: 200 BriefWirelessLANGroup: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 wirelesslan_count: type: integer readOnly: true default: 0 _depth: type: integer readOnly: true title: ' depth' required: - _depth - display - id - name - slug - url - wirelesslan_count InventoryItemTemplate: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device_type: $ref: '#/components/schemas/BriefDeviceType' parent: type: integer nullable: true name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 role: allOf: - $ref: '#/components/schemas/BriefInventoryItemRole' nullable: true manufacturer: allOf: - $ref: '#/components/schemas/BriefManufacturer' nullable: true part_id: type: string description: Manufacturer-assigned part identifier maxLength: 50 description: type: string maxLength: 200 component_type: type: string nullable: true component_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true component: readOnly: true nullable: true created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true _depth: type: integer readOnly: true title: ' depth' required: - _depth - component - created - device_type - display - id - last_updated - name - url PowerOutletTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c5 - iec-60320-c7 - iec-60320-c13 - iec-60320-c15 - iec-60320-c17 - iec-60320-c19 - iec-60320-c21 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15r - nema-5-15r - nema-5-20r - nema-5-30r - nema-5-50r - nema-6-15r - nema-6-20r - nema-6-30r - nema-6-50r - nema-10-30r - nema-10-50r - nema-14-20r - nema-14-30r - nema-14-50r - nema-14-60r - nema-15-15r - nema-15-20r - nema-15-30r - nema-15-50r - nema-15-60r - nema-l1-15r - nema-l5-15r - nema-l5-20r - nema-l5-30r - nema-l5-50r - nema-l6-15r - nema-l6-20r - nema-l6-30r - nema-l6-50r - nema-l10-30r - nema-l14-20r - nema-l14-30r - nema-l14-50r - nema-l14-60r - nema-l15-20r - nema-l15-30r - nema-l15-50r - nema-l15-60r - nema-l21-20r - nema-l21-30r - nema-l22-20r - nema-l22-30r - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ita-e - ita-f - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - ita-multistandard - usb-a - usb-micro-b - usb-c - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - eaton-c39 - hdot-cx - saf-d-grid - neutrik-powercon-20a - neutrik-powercon-32a - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c5` - C5 * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 * `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15r` - NEMA 1-15R * `nema-5-15r` - NEMA 5-15R * `nema-5-20r` - NEMA 5-20R * `nema-5-30r` - NEMA 5-30R * `nema-5-50r` - NEMA 5-50R * `nema-6-15r` - NEMA 6-15R * `nema-6-20r` - NEMA 6-20R * `nema-6-30r` - NEMA 6-30R * `nema-6-50r` - NEMA 6-50R * `nema-10-30r` - NEMA 10-30R * `nema-10-50r` - NEMA 10-50R * `nema-14-20r` - NEMA 14-20R * `nema-14-30r` - NEMA 14-30R * `nema-14-50r` - NEMA 14-50R * `nema-14-60r` - NEMA 14-60R * `nema-15-15r` - NEMA 15-15R * `nema-15-20r` - NEMA 15-20R * `nema-15-30r` - NEMA 15-30R * `nema-15-50r` - NEMA 15-50R * `nema-15-60r` - NEMA 15-60R * `nema-l1-15r` - NEMA L1-15R * `nema-l5-15r` - NEMA L5-15R * `nema-l5-20r` - NEMA L5-20R * `nema-l5-30r` - NEMA L5-30R * `nema-l5-50r` - NEMA L5-50R * `nema-l6-15r` - NEMA L6-15R * `nema-l6-20r` - NEMA L6-20R * `nema-l6-30r` - NEMA L6-30R * `nema-l6-50r` - NEMA L6-50R * `nema-l10-30r` - NEMA L10-30R * `nema-l14-20r` - NEMA L14-20R * `nema-l14-30r` - NEMA L14-30R * `nema-l14-50r` - NEMA L14-50R * `nema-l14-60r` - NEMA L14-60R * `nema-l15-20r` - NEMA L15-20R * `nema-l15-30r` - NEMA L15-30R * `nema-l15-50r` - NEMA L15-50R * `nema-l15-60r` - NEMA L15-60R * `nema-l21-20r` - NEMA L21-20R * `nema-l21-30r` - NEMA L21-30R * `nema-l22-20r` - NEMA L22-20R * `nema-l22-30r` - NEMA L22-30R * `CS6360C` - CS6360C * `CS6364C` - CS6364C * `CS8164C` - CS8164C * `CS8264C` - CS8264C * `CS8364C` - CS8364C * `CS8464C` - CS8464C * `ita-e` - ITA Type E (CEE 7/5) * `ita-f` - ITA Type F (CEE 7/3) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `ita-multistandard` - ITA Multistandard * `usb-a` - USB Type A * `usb-micro-b` - USB Micro B * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 * `hdot-cx` - HDOT Cx * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20a` - Neutrik powerCON (20A) * `neutrik-powercon-32a` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: db3e4eb2b93615f8 nullable: true color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 power_port: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPowerPortTemplateRequest' nullable: true nullable: true feed_leg: enum: - A - B - C - '' - null type: string description: '* `A` - A * `B` - B * `C` - C' x-spec-enum-id: a4902339df0b7c06 nullable: true description: type: string maxLength: 200 required: - name NestedDeviceRole: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 required: - display - display_url - id - name - url NestedPlatform: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 required: - display - display_url - id - name - url BriefUser: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 required: - display - id - url - username WritableInventoryItemRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' parent: type: integer nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 status: enum: - offline - active - planned - staged - failed - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning' x-spec-enum-id: 545817eb4c4f2ae4 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefInventoryItemRoleRequest' nullable: true nullable: true manufacturer: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefManufacturerRequest' nullable: true nullable: true part_id: type: string description: Manufacturer-assigned part identifier maxLength: 50 serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this item maxLength: 50 discovered: type: boolean description: This item was automatically discovered description: type: string maxLength: 200 component_type: type: string nullable: true component_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name BriefTenant: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - display - id - name - slug - url VirtualChassis: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 64 domain: type: string maxLength: 30 master: allOf: - $ref: '#/components/schemas/NestedDevice' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true member_count: type: integer readOnly: true members: type: array items: $ref: '#/components/schemas/NestedDevice' readOnly: true required: - created - display - display_url - id - last_updated - member_count - members - name - url BriefConfigTemplateRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name NestedDeviceRoleRequest: type: object 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.' properties: name: type: string minLength: 1 maxLength: 100 required: - name ConsoleServerPortTemplate: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device_type: allOf: - $ref: '#/components/schemas/BriefDeviceType' nullable: true module_type: allOf: - $ref: '#/components/schemas/BriefModuleType' nullable: true name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 label: type: string enum: - DE-9 - DB-25 - RJ-11 - RJ-12 - RJ-45 - Mini-DIN 8 - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB Micro AB - Other description: type: string maxLength: 200 created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - id - last_updated - name - url PowerOutletRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c5 - iec-60320-c7 - iec-60320-c13 - iec-60320-c15 - iec-60320-c17 - iec-60320-c19 - iec-60320-c21 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15r - nema-5-15r - nema-5-20r - nema-5-30r - nema-5-50r - nema-6-15r - nema-6-20r - nema-6-30r - nema-6-50r - nema-10-30r - nema-10-50r - nema-14-20r - nema-14-30r - nema-14-50r - nema-14-60r - nema-15-15r - nema-15-20r - nema-15-30r - nema-15-50r - nema-15-60r - nema-l1-15r - nema-l5-15r - nema-l5-20r - nema-l5-30r - nema-l5-50r - nema-l6-15r - nema-l6-20r - nema-l6-30r - nema-l6-50r - nema-l10-30r - nema-l14-20r - nema-l14-30r - nema-l14-50r - nema-l14-60r - nema-l15-20r - nema-l15-30r - nema-l15-50r - nema-l15-60r - nema-l21-20r - nema-l21-30r - nema-l22-20r - nema-l22-30r - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ita-e - ita-f - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - ita-multistandard - usb-a - usb-micro-b - usb-c - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - eaton-c39 - hdot-cx - saf-d-grid - neutrik-powercon-20a - neutrik-powercon-32a - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c5` - C5 * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 * `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15r` - NEMA 1-15R * `nema-5-15r` - NEMA 5-15R * `nema-5-20r` - NEMA 5-20R * `nema-5-30r` - NEMA 5-30R * `nema-5-50r` - NEMA 5-50R * `nema-6-15r` - NEMA 6-15R * `nema-6-20r` - NEMA 6-20R * `nema-6-30r` - NEMA 6-30R * `nema-6-50r` - NEMA 6-50R * `nema-10-30r` - NEMA 10-30R * `nema-10-50r` - NEMA 10-50R * `nema-14-20r` - NEMA 14-20R * `nema-14-30r` - NEMA 14-30R * `nema-14-50r` - NEMA 14-50R * `nema-14-60r` - NEMA 14-60R * `nema-15-15r` - NEMA 15-15R * `nema-15-20r` - NEMA 15-20R * `nema-15-30r` - NEMA 15-30R * `nema-15-50r` - NEMA 15-50R * `nema-15-60r` - NEMA 15-60R * `nema-l1-15r` - NEMA L1-15R * `nema-l5-15r` - NEMA L5-15R * `nema-l5-20r` - NEMA L5-20R * `nema-l5-30r` - NEMA L5-30R * `nema-l5-50r` - NEMA L5-50R * `nema-l6-15r` - NEMA L6-15R * `nema-l6-20r` - NEMA L6-20R * `nema-l6-30r` - NEMA L6-30R * `nema-l6-50r` - NEMA L6-50R * `nema-l10-30r` - NEMA L10-30R * `nema-l14-20r` - NEMA L14-20R * `nema-l14-30r` - NEMA L14-30R * `nema-l14-50r` - NEMA L14-50R * `nema-l14-60r` - NEMA L14-60R * `nema-l15-20r` - NEMA L15-20R * `nema-l15-30r` - NEMA L15-30R * `nema-l15-50r` - NEMA L15-50R * `nema-l15-60r` - NEMA L15-60R * `nema-l21-20r` - NEMA L21-20R * `nema-l21-30r` - NEMA L21-30R * `nema-l22-20r` - NEMA L22-20R * `nema-l22-30r` - NEMA L22-30R * `CS6360C` - CS6360C * `CS6364C` - CS6364C * `CS8164C` - CS8164C * `CS8264C` - CS8264C * `CS8364C` - CS8364C * `CS8464C` - CS8464C * `ita-e` - ITA Type E (CEE 7/5) * `ita-f` - ITA Type F (CEE 7/3) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `ita-multistandard` - ITA Multistandard * `usb-a` - USB Type A * `usb-micro-b` - USB Micro B * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 * `hdot-cx` - HDOT Cx * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20a` - Neutrik powerCON (20A) * `neutrik-powercon-32a` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: db3e4eb2b93615f8 nullable: true status: enum: - enabled - disabled - faulty type: string description: '* `enabled` - Enabled * `disabled` - Disabled * `faulty` - Faulty' x-spec-enum-id: d60dce16858f3c69 color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 power_port: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPowerPortRequest' nullable: true nullable: true feed_leg: enum: - A - B - C - '' - null type: string description: '* `A` - A * `B` - B * `C` - C' x-spec-enum-id: a4902339df0b7c06 nullable: true description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name PatchedWritableRackRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 facility_id: type: string nullable: true maxLength: 50 site: oneOf: - type: integer - $ref: '#/components/schemas/BriefSiteRequest' location: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefLocationRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - reserved - available - planned - active - deprecated type: string description: '* `reserved` - Reserved * `available` - Available * `planned` - Planned * `active` - Active * `deprecated` - Deprecated' x-spec-enum-id: 76eea4eef8804bcb role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackRoleRequest' nullable: true nullable: true serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this rack maxLength: 50 rack_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackTypeRequest' nullable: true nullable: true form_factor: enum: - 2-post-frame - 4-post-frame - 4-post-cabinet - wall-frame - wall-frame-vertical - wall-cabinet - wall-cabinet-vertical - '' - null type: string 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)' x-spec-enum-id: 8a902fde21d48841 nullable: true width: enum: - 10 - 19 - 21 - 23 type: integer x-spec-enum-id: 9b322795f297a9c3 description: 'Rail-to-rail width * `10` - 10 inches * `19` - 19 inches * `21` - 21 inches * `23` - 23 inches' minimum: 0 maximum: 32767 u_height: type: integer maximum: 100 minimum: 1 title: Height (U) description: Height in rack units starting_unit: type: integer maximum: 32767 minimum: 1 description: Starting unit for rack weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true max_weight: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Maximum load capacity for the rack weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true desc_units: type: boolean title: Descending units description: Units are numbered top-to-bottom outer_width: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (width) outer_height: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (height) outer_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (depth) outer_unit: enum: - mm - in - '' - null type: string description: '* `mm` - Millimeters * `in` - Inches' x-spec-enum-id: 3d701848b66312c3 nullable: true mounting_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails. airflow: enum: - front-to-rear - rear-to-front - '' - null type: string description: '* `front-to-rear` - Front to rear * `rear-to-front` - Rear to front' x-spec-enum-id: a784734d07ef1b3c nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} ASN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true asn: type: integer maximum: 4294967295 minimum: 1 format: int64 description: 16- or 32-bit autonomous system number rir: allOf: - $ref: '#/components/schemas/BriefRIR' nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true site_count: type: integer format: int64 readOnly: true provider_count: type: integer format: int64 readOnly: true sites: type: array items: $ref: '#/components/schemas/ASNSite' required: - asn - created - display - display_url - id - last_updated - provider_count - site_count - url WritableModuleRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module_bay: type: integer module_type: oneOf: - type: integer - $ref: '#/components/schemas/BriefModuleTypeRequest' status: enum: - offline - active - planned - staged - failed - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning' x-spec-enum-id: 545817eb4c4f2ae4 serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this device maxLength: 50 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - module_bay - module_type WritableInterfaceRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' vdcs: type: array items: type: integer module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - virtual - bridge - lag - 100base-fx - 100base-lfx - 100base-tx - 100base-t1 - 1000base-bx10-d - 1000base-bx10-u - 1000base-cwdm - 1000base-cx - 1000base-dwdm - 1000base-ex - 1000base-lsx - 1000base-lx - 1000base-lx10 - 1000base-sx - 1000base-t - 1000base-tx - 1000base-zx - 2.5gbase-t - 5gbase-t - 10gbase-br-d - 10gbase-br-u - 10gbase-cu - 10gbase-cx4 - 10gbase-er - 10gbase-lr - 10gbase-lrm - 10gbase-lx4 - 10gbase-sr - 10gbase-t - 10gbase-zr - 25gbase-cr - 25gbase-er - 25gbase-lr - 25gbase-sr - 25gbase-t - 40gbase-cr4 - 40gbase-er4 - 40gbase-fr4 - 40gbase-lr4 - 40gbase-sr4 - 40gbase-sr4-bd - 50gbase-cr - 50gbase-er - 50gbase-fr - 50gbase-lr - 50gbase-sr - 100gbase-cr1 - 100gbase-cr2 - 100gbase-cr4 - 100gbase-cr10 - 100gbase-cwdm4 - 100gbase-dr - 100gbase-er4 - 100gbase-fr1 - 100gbase-lr1 - 100gbase-lr4 - 100gbase-sr1 - 100gbase-sr1.2 - 100gbase-sr2 - 100gbase-sr4 - 100gbase-sr10 - 100gbase-zr - 200gbase-cr2 - 200gbase-cr4 - 200gbase-dr4 - 200gbase-er4 - 200gbase-fr4 - 200gbase-lr4 - 200gbase-sr2 - 200gbase-sr4 - 200gbase-vr2 - 400gbase-cr4 - 400gbase-dr4 - 400gbase-er8 - 400gbase-fr4 - 400gbase-fr8 - 400gbase-lr4 - 400gbase-lr8 - 400gbase-sr4 - 400gbase-sr4_2 - 400gbase-sr8 - 400gbase-sr16 - 400gbase-vr4 - 400gbase-zr - 800gbase-cr8 - 800gbase-dr8 - 800gbase-sr8 - 800gbase-vr8 - 1.6tbase-cr8 - 1.6tbase-dr8 - 1.6tbase-dr8-2 - 100base-x-sfp - 1000base-x-gbic - 1000base-x-sfp - 2.5gbase-x-sfp - 10gbase-x-sfpp - 10gbase-x-xenpak - 10gbase-x-xfp - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 50gbase-x-sfp56 - 100gbase-x-cfp - 100gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cxp - 100gbase-x-cpak - 100gbase-x-dsfp - 100gbase-x-qsfp28 - 100gbase-x-qsfpdd - 100gbase-x-sfpdd - 200gbase-x-cfp2 - 200gbase-x-qsfp56 - 200gbase-x-qsfpdd - 400gbase-x-qsfp112 - 400gbase-x-qsfpdd - 400gbase-x-cdfp - 400gbase-x-cfp2 - 400gbase-x-cfp8 - 400gbase-x-osfp - 400gbase-x-osfp-rhs - 800gbase-x-osfp - 800gbase-x-qsfpdd - 1.6tbase-x-osfp1600 - 1.6tbase-x-osfp1600-rhs - 1.6tbase-x-qsfpdd1600 - 1000base-kx - 2.5gbase-kx - 5gbase-kr - 10gbase-kr - 10gbase-kx4 - 25gbase-kr - 40gbase-kr4 - 50gbase-kr - 100gbase-kp4 - 100gbase-kr2 - 100gbase-kr4 - 1.6tbase-kr8 - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - ieee802.11ay - ieee802.11be - ieee802.15.1 - ieee802.15.4 - other-wireless - gsm - cdma - lte - 4g - 5g - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 32gfc-sfpp - 64gfc-qsfpp - 64gfc-sfpdd - 64gfc-sfpp - 128gfc-qsfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - xdsl - docsis - moca - bpon - epon - 10g-epon - gpon - xg-pon - xgs-pon - ng-pon2 - 25g-pon - 50g-pon - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - cisco-stackwise-80 - cisco-stackwise-160 - cisco-stackwise-320 - cisco-stackwise-480 - cisco-stackwise-1t - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string description: '* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) * `100base-fx` - 100BASE-FX (10/100ME) * `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) * `100base-t1` - 100BASE-T1 (10/100ME) * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) * `1000base-cwdm` - 1000BASE-CWDM (1GE) * `1000base-cx` - 1000BASE-CX (1GE DAC) * `1000base-dwdm` - 1000BASE-DWDM (1GE) * `1000base-ex` - 1000BASE-EX (1GE) * `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) * `1000base-lx10` - 1000BASE-LX10/LH (1GE) * `1000base-sx` - 1000BASE-SX (1GE) * `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) * `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) * `10gbase-er` - 10GBASE-ER (10GE) * `10gbase-lr` - 10GBASE-LR (10GE) * `10gbase-lrm` - 10GBASE-LRM (10GE) * `10gbase-lx4` - 10GBASE-LX4 (10GE) * `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) * `10gbase-zr` - 10GBASE-ZR (10GE) * `25gbase-cr` - 25GBASE-CR (25GE DAC) * `25gbase-er` - 25GBASE-ER (25GE) * `25gbase-lr` - 25GBASE-LR (25GE) * `25gbase-sr` - 25GBASE-SR (25GE) * `25gbase-t` - 25GBASE-T (25GE) * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) * `40gbase-er4` - 40GBASE-ER4 (40GE) * `40gbase-fr4` - 40GBASE-FR4 (40GE) * `40gbase-lr4` - 40GBASE-LR4 (40GE) * `40gbase-sr4` - 40GBASE-SR4 (40GE) * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) * `50gbase-cr` - 50GBASE-CR (50GE DAC) * `50gbase-er` - 50GBASE-ER (50GE) * `50gbase-fr` - 50GBASE-FR (50GE) * `50gbase-lr` - 50GBASE-LR (50GE) * `50gbase-sr` - 50GBASE-SR (50GE) * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) * `100gbase-dr` - 100GBASE-DR (100GE) * `100gbase-er4` - 100GBASE-ER4 (100GE) * `100gbase-fr1` - 100GBASE-FR1 (100GE) * `100gbase-lr1` - 100GBASE-LR1 (100GE) * `100gbase-lr4` - 100GBASE-LR4 (100GE) * `100gbase-sr1` - 100GBASE-SR1 (100GE) * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) * `100gbase-sr2` - 100GBASE-SR2 (100GE) * `100gbase-sr4` - 100GBASE-SR4 (100GE) * `100gbase-sr10` - 100GBASE-SR10 (100GE) * `100gbase-zr` - 100GBASE-ZR (100GE) * `200gbase-cr2` - 200GBASE-CR2 (200GE) * `200gbase-cr4` - 200GBASE-CR4 (200GE) * `200gbase-dr4` - 200GBASE-DR4 (200GE) * `200gbase-er4` - 200GBASE-ER4 (200GE) * `200gbase-fr4` - 200GBASE-FR4 (200GE) * `200gbase-lr4` - 200GBASE-LR4 (200GE) * `200gbase-sr2` - 200GBASE-SR2 (200GE) * `200gbase-sr4` - 200GBASE-SR4 (200GE) * `200gbase-vr2` - 200GBASE-VR2 (200GE) * `400gbase-cr4` - 400GBASE-CR4 (400GE) * `400gbase-dr4` - 400GBASE-DR4 (400GE) * `400gbase-er8` - 400GBASE-ER8 (400GE) * `400gbase-fr4` - 400GBASE-FR4 (400GE) * `400gbase-fr8` - 400GBASE-FR8 (400GE) * `400gbase-lr4` - 400GBASE-LR4 (400GE) * `400gbase-lr8` - 400GBASE-LR8 (400GE) * `400gbase-sr4` - 400GBASE-SR4 (400GE) * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) * `400gbase-sr8` - 400GBASE-SR8 (400GE) * `400gbase-sr16` - 400GBASE-SR16 (400GE) * `400gbase-vr4` - 400GBASE-VR4 (400GE) * `400gbase-zr` - 400GBASE-ZR (400GE) * `800gbase-cr8` - 800GBASE-CR8 (800GE) * `800gbase-dr8` - 800GBASE-DR8 (800GE) * `800gbase-sr8` - 800GBASE-SR8 (800GE) * `800gbase-vr8` - 800GBASE-VR8 (800GE) * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) * `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) * `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) * `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) * `100gbase-x-sfpdd` - SFP-DD (100GE) * `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) * `400gbase-x-cdfp` - CDFP (400GE) * `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) * `400gbase-x-osfp` - OSFP (400GE) * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) * `800gbase-x-qsfpdd` - QSFP-DD (800GE) * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) * `10gbase-kr` - 10GBASE-KR (10GE) * `10gbase-kx4` - 10GBASE-KX4 (10GE) * `25gbase-kr` - 25GBASE-KR (25GE) * `40gbase-kr4` - 40GBASE-KR4 (40GE) * `50gbase-kr` - 50GBASE-KR (50GE) * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) * `ieee802.11ad` - IEEE 802.11ad (WiGig) * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) * `ieee802.11ay` - IEEE 802.11ay (WiGig) * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) * `gsm` - GSM * `cdma` - CDMA * `lte` - LTE * `4g` - 4G * `5g` - 5G * `sonet-oc3` - OC-3/STM-1 * `sonet-oc12` - OC-12/STM-4 * `sonet-oc48` - OC-48/STM-16 * `sonet-oc192` - OC-192/STM-64 * `sonet-oc768` - OC-768/STM-256 * `sonet-oc1920` - OC-1920/STM-640 * `sonet-oc3840` - OC-3840/STM-1234 * `1gfc-sfp` - SFP (1GFC) * `2gfc-sfp` - SFP (2GFC) * `4gfc-sfp` - SFP (4GFC) * `8gfc-sfpp` - SFP+ (8GFC) * `16gfc-sfpp` - SFP+ (16GFC) * `32gfc-sfp28` - SFP28 (32GFC) * `32gfc-sfpp` - SFP+ (32GFC) * `64gfc-qsfpp` - QSFP+ (64GFC) * `64gfc-sfpdd` - SFP-DD (64GFC) * `64gfc-sfpp` - SFP+ (64GFC) * `128gfc-qsfp28` - QSFP28 (128GFC) * `infiniband-sdr` - SDR (2 Gbps) * `infiniband-ddr` - DDR (4 Gbps) * `infiniband-qdr` - QDR (8 Gbps) * `infiniband-fdr10` - FDR10 (10 Gbps) * `infiniband-fdr` - FDR (13.5 Gbps) * `infiniband-edr` - EDR (25 Gbps) * `infiniband-hdr` - HDR (50 Gbps) * `infiniband-ndr` - NDR (100 Gbps) * `infiniband-xdr` - XDR (250 Gbps) * `t1` - T1 (1.544 Mbps) * `e1` - E1 (2.048 Mbps) * `t3` - T3 (45 Mbps) * `e3` - E3 (34 Mbps) * `xdsl` - xDSL * `docsis` - DOCSIS * `moca` - MoCA * `bpon` - BPON (622 Mbps / 155 Mbps) * `epon` - EPON (1 Gbps) * `10g-epon` - 10G-EPON (10 Gbps) * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) * `xgs-pon` - XGS-PON (10 Gbps) * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) * `25g-pon` - 25G-PON (25 Gbps) * `50g-pon` - 50G-PON (50 Gbps) * `cisco-stackwise` - Cisco StackWise * `cisco-stackwise-plus` - Cisco StackWise Plus * `cisco-flexstack` - Cisco FlexStack * `cisco-flexstack-plus` - Cisco FlexStack Plus * `cisco-stackwise-80` - Cisco StackWise-80 * `cisco-stackwise-160` - Cisco StackWise-160 * `cisco-stackwise-320` - Cisco StackWise-320 * `cisco-stackwise-480` - Cisco StackWise-480 * `cisco-stackwise-1t` - Cisco StackWise-1T * `juniper-vcp` - Juniper VCP * `extreme-summitstack` - Extreme SummitStack * `extreme-summitstack-128` - Extreme SummitStack-128 * `extreme-summitstack-256` - Extreme SummitStack-256 * `extreme-summitstack-512` - Extreme SummitStack-512 * `other` - Other' x-spec-enum-id: b067eb1f050c6ae9 enabled: type: boolean parent: type: integer nullable: true title: Parent interface bridge: type: integer nullable: true title: Bridge interface lag: type: integer nullable: true title: Parent LAG mtu: type: integer maximum: 65536 minimum: 1 nullable: true primary_mac_address: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefMACAddressRequest' nullable: true nullable: true speed: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true title: Speed (Kbps) duplex: enum: - half - full - auto - '' - null type: string description: '* `half` - Half * `full` - Full * `auto` - Auto' x-spec-enum-id: 368458a2b67c916b nullable: true wwn: type: string nullable: true mgmt_only: type: boolean title: Management only description: This interface is used only for out-of-band management description: type: string maxLength: 200 mode: enum: - access - tagged - tagged-all - q-in-q - '' - null type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 'IEEE 802.1Q tagging strategy * `access` - Access * `tagged` - Tagged * `tagged-all` - Tagged (All) * `q-in-q` - Q-in-Q (802.1ad)' rf_role: enum: - ap - station - '' - null type: string description: '* `ap` - Access point * `station` - Station' x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role rf_channel: enum: - 2.4g-1-2412-22 - 2.4g-2-2417-22 - 2.4g-3-2422-22 - 2.4g-4-2427-22 - 2.4g-5-2432-22 - 2.4g-6-2437-22 - 2.4g-7-2442-22 - 2.4g-8-2447-22 - 2.4g-9-2452-22 - 2.4g-10-2457-22 - 2.4g-11-2462-22 - 2.4g-12-2467-22 - 2.4g-13-2472-22 - 5g-32-5160-20 - 5g-34-5170-40 - 5g-36-5180-20 - 5g-38-5190-40 - 5g-40-5200-20 - 5g-42-5210-80 - 5g-44-5220-20 - 5g-46-5230-40 - 5g-48-5240-20 - 5g-50-5250-160 - 5g-52-5260-20 - 5g-54-5270-40 - 5g-56-5280-20 - 5g-58-5290-80 - 5g-60-5300-20 - 5g-62-5310-40 - 5g-64-5320-20 - 5g-100-5500-20 - 5g-102-5510-40 - 5g-104-5520-20 - 5g-106-5530-80 - 5g-108-5540-20 - 5g-110-5550-40 - 5g-112-5560-20 - 5g-114-5570-160 - 5g-116-5580-20 - 5g-118-5590-40 - 5g-120-5600-20 - 5g-122-5610-80 - 5g-124-5620-20 - 5g-126-5630-40 - 5g-128-5640-20 - 5g-132-5660-20 - 5g-134-5670-40 - 5g-136-5680-20 - 5g-138-5690-80 - 5g-140-5700-20 - 5g-142-5710-40 - 5g-144-5720-20 - 5g-149-5745-20 - 5g-151-5755-40 - 5g-153-5765-20 - 5g-155-5775-80 - 5g-157-5785-20 - 5g-159-5795-40 - 5g-161-5805-20 - 5g-163-5815-160 - 5g-165-5825-20 - 5g-167-5835-40 - 5g-169-5845-20 - 5g-171-5855-80 - 5g-173-5865-20 - 5g-175-5875-40 - 5g-177-5885-20 - 6g-1-5955-20 - 6g-3-5965-40 - 6g-5-5975-20 - 6g-7-5985-80 - 6g-9-5995-20 - 6g-11-6005-40 - 6g-13-6015-20 - 6g-15-6025-160 - 6g-17-6035-20 - 6g-19-6045-40 - 6g-21-6055-20 - 6g-23-6065-80 - 6g-25-6075-20 - 6g-27-6085-40 - 6g-29-6095-20 - 6g-31-6105-320 - 6g-33-6115-20 - 6g-35-6125-40 - 6g-37-6135-20 - 6g-39-6145-80 - 6g-41-6155-20 - 6g-43-6165-40 - 6g-45-6175-20 - 6g-47-6185-160 - 6g-49-6195-20 - 6g-51-6205-40 - 6g-53-6215-20 - 6g-55-6225-80 - 6g-57-6235-20 - 6g-59-6245-40 - 6g-61-6255-20 - 6g-65-6275-20 - 6g-67-6285-40 - 6g-69-6295-20 - 6g-71-6305-80 - 6g-73-6315-20 - 6g-75-6325-40 - 6g-77-6335-20 - 6g-79-6345-160 - 6g-81-6355-20 - 6g-83-6365-40 - 6g-85-6375-20 - 6g-87-6385-80 - 6g-89-6395-20 - 6g-91-6405-40 - 6g-93-6415-20 - 6g-95-6425-320 - 6g-97-6435-20 - 6g-99-6445-40 - 6g-101-6455-20 - 6g-103-6465-80 - 6g-105-6475-20 - 6g-107-6485-40 - 6g-109-6495-20 - 6g-111-6505-160 - 6g-113-6515-20 - 6g-115-6525-40 - 6g-117-6535-20 - 6g-119-6545-80 - 6g-121-6555-20 - 6g-123-6565-40 - 6g-125-6575-20 - 6g-129-6595-20 - 6g-131-6605-40 - 6g-133-6615-20 - 6g-135-6625-80 - 6g-137-6635-20 - 6g-139-6645-40 - 6g-141-6655-20 - 6g-143-6665-160 - 6g-145-6675-20 - 6g-147-6685-40 - 6g-149-6695-20 - 6g-151-6705-80 - 6g-153-6715-20 - 6g-155-6725-40 - 6g-157-6735-20 - 6g-159-6745-320 - 6g-161-6755-20 - 6g-163-6765-40 - 6g-165-6775-20 - 6g-167-6785-80 - 6g-169-6795-20 - 6g-171-6805-40 - 6g-173-6815-20 - 6g-175-6825-160 - 6g-177-6835-20 - 6g-179-6845-40 - 6g-181-6855-20 - 6g-183-6865-80 - 6g-185-6875-20 - 6g-187-6885-40 - 6g-189-6895-20 - 6g-193-6915-20 - 6g-195-6925-40 - 6g-197-6935-20 - 6g-199-6945-80 - 6g-201-6955-20 - 6g-203-6965-40 - 6g-205-6975-20 - 6g-207-6985-160 - 6g-209-6995-20 - 6g-211-7005-40 - 6g-213-7015-20 - 6g-215-7025-80 - 6g-217-7035-20 - 6g-219-7045-40 - 6g-221-7055-20 - 6g-225-7075-20 - 6g-227-7085-40 - 6g-229-7095-20 - 6g-233-7115-20 - 60g-1-58320-2160 - 60g-2-60480-2160 - 60g-3-62640-2160 - 60g-4-64800-2160 - 60g-5-66960-2160 - 60g-6-69120-2160 - 60g-9-59400-4320 - 60g-10-61560-4320 - 60g-11-63720-4320 - 60g-12-65880-4320 - 60g-13-68040-4320 - 60g-17-60480-6480 - 60g-18-62640-6480 - 60g-19-64800-6480 - 60g-20-66960-6480 - 60g-25-61560-6480 - 60g-26-63720-6480 - 60g-27-65880-6480 - '' - null type: string description: '* `2.4g-1-2412-22` - 1 (2412 MHz) * `2.4g-2-2417-22` - 2 (2417 MHz) * `2.4g-3-2422-22` - 3 (2422 MHz) * `2.4g-4-2427-22` - 4 (2427 MHz) * `2.4g-5-2432-22` - 5 (2432 MHz) * `2.4g-6-2437-22` - 6 (2437 MHz) * `2.4g-7-2442-22` - 7 (2442 MHz) * `2.4g-8-2447-22` - 8 (2447 MHz) * `2.4g-9-2452-22` - 9 (2452 MHz) * `2.4g-10-2457-22` - 10 (2457 MHz) * `2.4g-11-2462-22` - 11 (2462 MHz) * `2.4g-12-2467-22` - 12 (2467 MHz) * `2.4g-13-2472-22` - 13 (2472 MHz) * `5g-32-5160-20` - 32 (5160/20 MHz) * `5g-34-5170-40` - 34 (5170/40 MHz) * `5g-36-5180-20` - 36 (5180/20 MHz) * `5g-38-5190-40` - 38 (5190/40 MHz) * `5g-40-5200-20` - 40 (5200/20 MHz) * `5g-42-5210-80` - 42 (5210/80 MHz) * `5g-44-5220-20` - 44 (5220/20 MHz) * `5g-46-5230-40` - 46 (5230/40 MHz) * `5g-48-5240-20` - 48 (5240/20 MHz) * `5g-50-5250-160` - 50 (5250/160 MHz) * `5g-52-5260-20` - 52 (5260/20 MHz) * `5g-54-5270-40` - 54 (5270/40 MHz) * `5g-56-5280-20` - 56 (5280/20 MHz) * `5g-58-5290-80` - 58 (5290/80 MHz) * `5g-60-5300-20` - 60 (5300/20 MHz) * `5g-62-5310-40` - 62 (5310/40 MHz) * `5g-64-5320-20` - 64 (5320/20 MHz) * `5g-100-5500-20` - 100 (5500/20 MHz) * `5g-102-5510-40` - 102 (5510/40 MHz) * `5g-104-5520-20` - 104 (5520/20 MHz) * `5g-106-5530-80` - 106 (5530/80 MHz) * `5g-108-5540-20` - 108 (5540/20 MHz) * `5g-110-5550-40` - 110 (5550/40 MHz) * `5g-112-5560-20` - 112 (5560/20 MHz) * `5g-114-5570-160` - 114 (5570/160 MHz) * `5g-116-5580-20` - 116 (5580/20 MHz) * `5g-118-5590-40` - 118 (5590/40 MHz) * `5g-120-5600-20` - 120 (5600/20 MHz) * `5g-122-5610-80` - 122 (5610/80 MHz) * `5g-124-5620-20` - 124 (5620/20 MHz) * `5g-126-5630-40` - 126 (5630/40 MHz) * `5g-128-5640-20` - 128 (5640/20 MHz) * `5g-132-5660-20` - 132 (5660/20 MHz) * `5g-134-5670-40` - 134 (5670/40 MHz) * `5g-136-5680-20` - 136 (5680/20 MHz) * `5g-138-5690-80` - 138 (5690/80 MHz) * `5g-140-5700-20` - 140 (5700/20 MHz) * `5g-142-5710-40` - 142 (5710/40 MHz) * `5g-144-5720-20` - 144 (5720/20 MHz) * `5g-149-5745-20` - 149 (5745/20 MHz) * `5g-151-5755-40` - 151 (5755/40 MHz) * `5g-153-5765-20` - 153 (5765/20 MHz) * `5g-155-5775-80` - 155 (5775/80 MHz) * `5g-157-5785-20` - 157 (5785/20 MHz) * `5g-159-5795-40` - 159 (5795/40 MHz) * `5g-161-5805-20` - 161 (5805/20 MHz) * `5g-163-5815-160` - 163 (5815/160 MHz) * `5g-165-5825-20` - 165 (5825/20 MHz) * `5g-167-5835-40` - 167 (5835/40 MHz) * `5g-169-5845-20` - 169 (5845/20 MHz) * `5g-171-5855-80` - 171 (5855/80 MHz) * `5g-173-5865-20` - 173 (5865/20 MHz) * `5g-175-5875-40` - 175 (5875/40 MHz) * `5g-177-5885-20` - 177 (5885/20 MHz) * `6g-1-5955-20` - 1 (5955/20 MHz) * `6g-3-5965-40` - 3 (5965/40 MHz) * `6g-5-5975-20` - 5 (5975/20 MHz) * `6g-7-5985-80` - 7 (5985/80 MHz) * `6g-9-5995-20` - 9 (5995/20 MHz) * `6g-11-6005-40` - 11 (6005/40 MHz) * `6g-13-6015-20` - 13 (6015/20 MHz) * `6g-15-6025-160` - 15 (6025/160 MHz) * `6g-17-6035-20` - 17 (6035/20 MHz) * `6g-19-6045-40` - 19 (6045/40 MHz) * `6g-21-6055-20` - 21 (6055/20 MHz) * `6g-23-6065-80` - 23 (6065/80 MHz) * `6g-25-6075-20` - 25 (6075/20 MHz) * `6g-27-6085-40` - 27 (6085/40 MHz) * `6g-29-6095-20` - 29 (6095/20 MHz) * `6g-31-6105-320` - 31 (6105/320 MHz) * `6g-33-6115-20` - 33 (6115/20 MHz) * `6g-35-6125-40` - 35 (6125/40 MHz) * `6g-37-6135-20` - 37 (6135/20 MHz) * `6g-39-6145-80` - 39 (6145/80 MHz) * `6g-41-6155-20` - 41 (6155/20 MHz) * `6g-43-6165-40` - 43 (6165/40 MHz) * `6g-45-6175-20` - 45 (6175/20 MHz) * `6g-47-6185-160` - 47 (6185/160 MHz) * `6g-49-6195-20` - 49 (6195/20 MHz) * `6g-51-6205-40` - 51 (6205/40 MHz) * `6g-53-6215-20` - 53 (6215/20 MHz) * `6g-55-6225-80` - 55 (6225/80 MHz) * `6g-57-6235-20` - 57 (6235/20 MHz) * `6g-59-6245-40` - 59 (6245/40 MHz) * `6g-61-6255-20` - 61 (6255/20 MHz) * `6g-65-6275-20` - 65 (6275/20 MHz) * `6g-67-6285-40` - 67 (6285/40 MHz) * `6g-69-6295-20` - 69 (6295/20 MHz) * `6g-71-6305-80` - 71 (6305/80 MHz) * `6g-73-6315-20` - 73 (6315/20 MHz) * `6g-75-6325-40` - 75 (6325/40 MHz) * `6g-77-6335-20` - 77 (6335/20 MHz) * `6g-79-6345-160` - 79 (6345/160 MHz) * `6g-81-6355-20` - 81 (6355/20 MHz) * `6g-83-6365-40` - 83 (6365/40 MHz) * `6g-85-6375-20` - 85 (6375/20 MHz) * `6g-87-6385-80` - 87 (6385/80 MHz) * `6g-89-6395-20` - 89 (6395/20 MHz) * `6g-91-6405-40` - 91 (6405/40 MHz) * `6g-93-6415-20` - 93 (6415/20 MHz) * `6g-95-6425-320` - 95 (6425/320 MHz) * `6g-97-6435-20` - 97 (6435/20 MHz) * `6g-99-6445-40` - 99 (6445/40 MHz) * `6g-101-6455-20` - 101 (6455/20 MHz) * `6g-103-6465-80` - 103 (6465/80 MHz) * `6g-105-6475-20` - 105 (6475/20 MHz) * `6g-107-6485-40` - 107 (6485/40 MHz) * `6g-109-6495-20` - 109 (6495/20 MHz) * `6g-111-6505-160` - 111 (6505/160 MHz) * `6g-113-6515-20` - 113 (6515/20 MHz) * `6g-115-6525-40` - 115 (6525/40 MHz) * `6g-117-6535-20` - 117 (6535/20 MHz) * `6g-119-6545-80` - 119 (6545/80 MHz) * `6g-121-6555-20` - 121 (6555/20 MHz) * `6g-123-6565-40` - 123 (6565/40 MHz) * `6g-125-6575-20` - 125 (6575/20 MHz) * `6g-129-6595-20` - 129 (6595/20 MHz) * `6g-131-6605-40` - 131 (6605/40 MHz) * `6g-133-6615-20` - 133 (6615/20 MHz) * `6g-135-6625-80` - 135 (6625/80 MHz) * `6g-137-6635-20` - 137 (6635/20 MHz) * `6g-139-6645-40` - 139 (6645/40 MHz) * `6g-141-6655-20` - 141 (6655/20 MHz) * `6g-143-6665-160` - 143 (6665/160 MHz) * `6g-145-6675-20` - 145 (6675/20 MHz) * `6g-147-6685-40` - 147 (6685/40 MHz) * `6g-149-6695-20` - 149 (6695/20 MHz) * `6g-151-6705-80` - 151 (6705/80 MHz) * `6g-153-6715-20` - 153 (6715/20 MHz) * `6g-155-6725-40` - 155 (6725/40 MHz) * `6g-157-6735-20` - 157 (6735/20 MHz) * `6g-159-6745-320` - 159 (6745/320 MHz) * `6g-161-6755-20` - 161 (6755/20 MHz) * `6g-163-6765-40` - 163 (6765/40 MHz) * `6g-165-6775-20` - 165 (6775/20 MHz) * `6g-167-6785-80` - 167 (6785/80 MHz) * `6g-169-6795-20` - 169 (6795/20 MHz) * `6g-171-6805-40` - 171 (6805/40 MHz) * `6g-173-6815-20` - 173 (6815/20 MHz) * `6g-175-6825-160` - 175 (6825/160 MHz) * `6g-177-6835-20` - 177 (6835/20 MHz) * `6g-179-6845-40` - 179 (6845/40 MHz) * `6g-181-6855-20` - 181 (6855/20 MHz) * `6g-183-6865-80` - 183 (6865/80 MHz) * `6g-185-6875-20` - 185 (6875/20 MHz) * `6g-187-6885-40` - 187 (6885/40 MHz) * `6g-189-6895-20` - 189 (6895/20 MHz) * `6g-193-6915-20` - 193 (6915/20 MHz) * `6g-195-6925-40` - 195 (6925/40 MHz) * `6g-197-6935-20` - 197 (6935/20 MHz) * `6g-199-6945-80` - 199 (6945/80 MHz) * `6g-201-6955-20` - 201 (6955/20 MHz) * `6g-203-6965-40` - 203 (6965/40 MHz) * `6g-205-6975-20` - 205 (6975/20 MHz) * `6g-207-6985-160` - 207 (6985/160 MHz) * `6g-209-6995-20` - 209 (6995/20 MHz) * `6g-211-7005-40` - 211 (7005/40 MHz) * `6g-213-7015-20` - 213 (7015/20 MHz) * `6g-215-7025-80` - 215 (7025/80 MHz) * `6g-217-7035-20` - 217 (7035/20 MHz) * `6g-219-7045-40` - 219 (7045/40 MHz) * `6g-221-7055-20` - 221 (7055/20 MHz) * `6g-225-7075-20` - 225 (7075/20 MHz) * `6g-227-7085-40` - 227 (7085/40 MHz) * `6g-229-7095-20` - 229 (7095/20 MHz) * `6g-233-7115-20` - 233 (7115/20 MHz) * `60g-1-58320-2160` - 1 (58.32/2.16 GHz) * `60g-2-60480-2160` - 2 (60.48/2.16 GHz) * `60g-3-62640-2160` - 3 (62.64/2.16 GHz) * `60g-4-64800-2160` - 4 (64.80/2.16 GHz) * `60g-5-66960-2160` - 5 (66.96/2.16 GHz) * `60g-6-69120-2160` - 6 (69.12/2.16 GHz) * `60g-9-59400-4320` - 9 (59.40/4.32 GHz) * `60g-10-61560-4320` - 10 (61.56/4.32 GHz) * `60g-11-63720-4320` - 11 (63.72/4.32 GHz) * `60g-12-65880-4320` - 12 (65.88/4.32 GHz) * `60g-13-68040-4320` - 13 (68.04/4.32 GHz) * `60g-17-60480-6480` - 17 (60.48/6.48 GHz) * `60g-18-62640-6480` - 18 (62.64/6.48 GHz) * `60g-19-64800-6480` - 19 (64.80/6.48 GHz) * `60g-20-66960-6480` - 20 (66.96/6.48 GHz) * `60g-25-61560-6480` - 25 (61.56/8.64 GHz) * `60g-26-63720-6480` - 26 (63.72/8.64 GHz) * `60g-27-65880-6480` - 27 (65.88/8.64 GHz)' x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel poe_mode: enum: - pd - pse - '' - null type: string description: '* `pd` - PD * `pse` - PSE' x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true poe_type: enum: - type1-ieee802.3af - type2-ieee802.3at - type3-ieee802.3bt - type4-ieee802.3bt - passive-24v-2pair - passive-24v-4pair - passive-48v-2pair - passive-48v-4pair - '' - null type: string description: '* `type1-ieee802.3af` - 802.3af (Type 1) * `type2-ieee802.3at` - 802.3at (Type 2) * `type3-ieee802.3bt` - 802.3bt (Type 3) * `type4-ieee802.3bt` - 802.3bt (Type 4) * `passive-24v-2pair` - Passive 24V (2-pair) * `passive-24v-4pair` - Passive 24V (4-pair) * `passive-48v-2pair` - Passive 48V (2-pair) * `passive-48v-4pair` - Passive 48V (4-pair)' x-spec-enum-id: 5473d57885f237ab nullable: true rf_channel_frequency: type: number format: double maximum: 100000 minimum: -100000 exclusiveMaximum: true exclusiveMinimum: true nullable: true title: Channel frequency (MHz) description: Populated by selected channel (if set) rf_channel_width: type: number format: double maximum: 10000 minimum: -10000 exclusiveMaximum: true exclusiveMinimum: true nullable: true title: Channel width (MHz) description: Populated by selected channel (if set) tx_power: type: integer maximum: 127 minimum: -40 nullable: true title: Transmit power (dBm) untagged_vlan: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANRequest' nullable: true nullable: true tagged_vlans: type: array items: type: integer qinq_svlan: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANRequest' nullable: true nullable: true vlan_translation_policy: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANTranslationPolicyRequest' nullable: true nullable: true mark_connected: type: boolean description: Treat as if a cable is connected wireless_lans: type: array items: type: integer vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name - type BriefDeviceRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string nullable: true maxLength: 64 description: type: string maxLength: 200 PaginatedRearPortTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/RearPortTemplate' PowerPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - iec-60320-c6 - iec-60320-c8 - iec-60320-c14 - iec-60320-c16 - iec-60320-c18 - iec-60320-c20 - iec-60320-c22 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15p - nema-5-15p - nema-5-20p - nema-5-30p - nema-5-50p - nema-6-15p - nema-6-20p - nema-6-30p - nema-6-50p - nema-10-30p - nema-10-50p - nema-14-20p - nema-14-30p - nema-14-50p - nema-14-60p - nema-15-15p - nema-15-20p - nema-15-30p - nema-15-50p - nema-15-60p - nema-l1-15p - nema-l5-15p - nema-l5-20p - nema-l5-30p - nema-l5-50p - nema-l6-15p - nema-l6-20p - nema-l6-30p - nema-l6-50p - nema-l10-30p - nema-l14-20p - nema-l14-30p - nema-l14-50p - nema-l14-60p - nema-l15-20p - nema-l15-30p - nema-l15-50p - nema-l15-60p - nema-l21-20p - nema-l21-30p - nema-l22-20p - nema-l22-30p - cs6361c - cs6365c - cs8165c - cs8265c - cs8365c - cs8465c - ita-c - ita-e - ita-f - ita-ef - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - usb-3-b - usb-3-micro-b - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - saf-d-grid - neutrik-powercon-20 - neutrik-powercon-32 - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c6` - C6 * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 * `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15p` - NEMA 1-15P * `nema-5-15p` - NEMA 5-15P * `nema-5-20p` - NEMA 5-20P * `nema-5-30p` - NEMA 5-30P * `nema-5-50p` - NEMA 5-50P * `nema-6-15p` - NEMA 6-15P * `nema-6-20p` - NEMA 6-20P * `nema-6-30p` - NEMA 6-30P * `nema-6-50p` - NEMA 6-50P * `nema-10-30p` - NEMA 10-30P * `nema-10-50p` - NEMA 10-50P * `nema-14-20p` - NEMA 14-20P * `nema-14-30p` - NEMA 14-30P * `nema-14-50p` - NEMA 14-50P * `nema-14-60p` - NEMA 14-60P * `nema-15-15p` - NEMA 15-15P * `nema-15-20p` - NEMA 15-20P * `nema-15-30p` - NEMA 15-30P * `nema-15-50p` - NEMA 15-50P * `nema-15-60p` - NEMA 15-60P * `nema-l1-15p` - NEMA L1-15P * `nema-l5-15p` - NEMA L5-15P * `nema-l5-20p` - NEMA L5-20P * `nema-l5-30p` - NEMA L5-30P * `nema-l5-50p` - NEMA L5-50P * `nema-l6-15p` - NEMA L6-15P * `nema-l6-20p` - NEMA L6-20P * `nema-l6-30p` - NEMA L6-30P * `nema-l6-50p` - NEMA L6-50P * `nema-l10-30p` - NEMA L10-30P * `nema-l14-20p` - NEMA L14-20P * `nema-l14-30p` - NEMA L14-30P * `nema-l14-50p` - NEMA L14-50P * `nema-l14-60p` - NEMA L14-60P * `nema-l15-20p` - NEMA L15-20P * `nema-l15-30p` - NEMA L15-30P * `nema-l15-50p` - NEMA L15-50P * `nema-l15-60p` - NEMA L15-60P * `nema-l21-20p` - NEMA L21-20P * `nema-l21-30p` - NEMA L21-30P * `nema-l22-20p` - NEMA L22-20P * `nema-l22-30p` - NEMA L22-30P * `cs6361c` - CS6361C * `cs6365c` - CS6365C * `cs8165c` - CS8165C * `cs8265c` - CS8265C * `cs8365c` - CS8365C * `cs8465c` - CS8465C * `ita-c` - ITA Type C (CEE 7/16) * `ita-e` - ITA Type E (CEE 7/6) * `ita-f` - ITA Type F (CEE 7/4) * `ita-ef` - ITA Type E/F (CEE 7/7) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `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 * `usb-3-b` - USB 3.0 Type B * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20` - Neutrik powerCON (20A) * `neutrik-powercon-32` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: aadcbe6ca854c1ed nullable: true maximum_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Maximum power draw (watts) allocated_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Allocated power draw (watts) description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name BriefUserRequest: type: object 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)' properties: username: type: string minLength: 1 description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 required: - username PaginatedVirtualChassisList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/VirtualChassis' BriefPlatformRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug FrontPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 rear_ports: type: array items: $ref: '#/components/schemas/FrontPortMappingRequest' description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name - type RearPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 front_ports: type: array items: $ref: '#/components/schemas/RearPortTemplateMappingRequest' description: type: string maxLength: 200 required: - name - type FrontPort: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' module: allOf: - $ref: '#/components/schemas/BriefModule' nullable: true name: type: string maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c label: type: string enum: - 8P8C - 8P6C - 8P4C - 8P2C - 6P6C - 6P4C - 6P2C - 4P4C - 4P2C - GG45 - TERA 4P - TERA 2P - TERA 1P - 110 Punch - BNC - F Connector - N Connector - MRJ21 - FC - FC/PC - FC/UPC - FC/APC - LC - LC/PC - LC/UPC - LC/APC - LSH - LSH/PC - LSH/UPC - LSH/APC - LX.5 - LX.5/PC - LX.5/UPC - LX.5/APC - MPO - MTRJ - SC - SC/PC - SC/UPC - SC/APC - ST - CS - SN - SMA 905 - SMA 906 - URM-P2 - URM-P4 - URM-P8 - Splice - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB Micro AB - Other color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 rear_ports: type: array items: $ref: '#/components/schemas/FrontPortMapping' description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected cable: allOf: - $ref: '#/components/schemas/BriefCable' readOnly: true nullable: true cable_end: type: string readOnly: true link_peers: type: array items: {} readOnly: true link_peers_type: type: string description: Return the type of the peer link terminations, or None. readOnly: true nullable: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - cable - cable_end - created - device - display - display_url - id - last_updated - link_peers - link_peers_type - name - type - url SiteRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 description: Full name of the site maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ status: enum: - planned - staging - active - decommissioning - retired type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `retired` - Retired' x-spec-enum-id: 1cf60831fbb35e7f region: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRegionRequest' nullable: true nullable: true group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefSiteGroupRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true facility: type: string description: Local facility ID or description maxLength: 50 time_zone: type: string nullable: true minLength: 1 description: type: string maxLength: 200 physical_address: type: string description: Physical location of the building maxLength: 200 shipping_address: type: string description: If different from the physical address maxLength: 200 latitude: type: number format: double maximum: 90.0 minimum: -90.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) longitude: type: number format: double maximum: 180.0 minimum: -180.0 nullable: true description: GPS coordinate in decimal format (xx.yyyyyy) owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string asns: type: array items: type: integer tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug RackRole: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true rack_count: type: integer format: int64 readOnly: true required: - created - display - display_url - id - last_updated - name - rack_count - slug - url PatchedMACAddressRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: mac_address: type: string minLength: 1 assigned_object_type: type: string nullable: true assigned_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PowerFeedRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: power_panel: oneOf: - type: integer - $ref: '#/components/schemas/BriefPowerPanelRequest' rack: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 100 status: enum: - offline - active - planned - failed type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `failed` - Failed' x-spec-enum-id: ec530572dc778583 type: enum: - primary - redundant type: string description: '* `primary` - Primary * `redundant` - Redundant' x-spec-enum-id: 093a164236819eb8 supply: enum: - ac - dc type: string description: '* `ac` - AC * `dc` - DC' x-spec-enum-id: 1b6d99616ca6412b phase: enum: - single-phase - three-phase type: string description: '* `single-phase` - Single phase * `three-phase` - Three-phase' x-spec-enum-id: 994bc0696f4df57f voltage: type: integer maximum: 32767 minimum: -32768 amperage: type: integer maximum: 32767 minimum: 1 max_utilization: type: integer maximum: 100 minimum: 1 description: Maximum permissible draw (percentage) mark_connected: type: boolean description: Treat as if a cable is connected description: type: string maxLength: 200 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - power_panel SiteGroup: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ parent: allOf: - $ref: '#/components/schemas/NestedSiteGroup' nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true site_count: type: integer readOnly: true default: 0 prefix_count: type: integer format: int64 readOnly: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string _depth: type: integer readOnly: true title: ' depth' required: - _depth - created - display - display_url - id - last_updated - name - prefix_count - site_count - slug - url PaginatedRearPortList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/RearPort' BriefMACAddress: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true mac_address: type: string description: type: string maxLength: 200 required: - display - id - mac_address - url PaginatedVirtualDeviceContextList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/VirtualDeviceContext' PaginatedRackUnitList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/RackUnit' BriefL2VPNTermination: type: object description: Adds support for custom fields and tags. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true l2vpn: $ref: '#/components/schemas/BriefL2VPN' required: - display - id - l2vpn - url RackRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 facility_id: type: string nullable: true maxLength: 50 site: oneOf: - type: integer - $ref: '#/components/schemas/BriefSiteRequest' location: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefLocationRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - reserved - available - planned - active - deprecated type: string description: '* `reserved` - Reserved * `available` - Available * `planned` - Planned * `active` - Active * `deprecated` - Deprecated' x-spec-enum-id: 76eea4eef8804bcb role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackRoleRequest' nullable: true nullable: true serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this rack maxLength: 50 rack_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackTypeRequest' nullable: true nullable: true form_factor: enum: - 2-post-frame - 4-post-frame - 4-post-cabinet - wall-frame - wall-frame-vertical - wall-cabinet - wall-cabinet-vertical - '' - null type: string 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)' x-spec-enum-id: 8a902fde21d48841 nullable: true width: enum: - 10 - 19 - 21 - 23 type: integer description: '* `10` - 10 inches * `19` - 19 inches * `21` - 21 inches * `23` - 23 inches' x-spec-enum-id: 9b322795f297a9c3 u_height: type: integer maximum: 100 minimum: 1 title: Height (U) description: Height in rack units starting_unit: type: integer maximum: 32767 minimum: 1 description: Starting unit for rack weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true max_weight: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Maximum load capacity for the rack weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true desc_units: type: boolean title: Descending units description: Units are numbered top-to-bottom outer_width: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (width) outer_height: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (height) outer_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (depth) outer_unit: enum: - mm - in - '' - null type: string description: '* `mm` - Millimeters * `in` - Inches' x-spec-enum-id: 3d701848b66312c3 nullable: true mounting_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails. airflow: enum: - front-to-rear - rear-to-front - '' type: string description: '* `front-to-rear` - Front to rear * `rear-to-front` - Rear to front' x-spec-enum-id: a784734d07ef1b3c description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - site FrontPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 rear_ports: type: array items: $ref: '#/components/schemas/FrontPortTemplateMappingRequest' description: type: string maxLength: 200 required: - name - type DeviceRole: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 vm_role: type: boolean description: Virtual machines may be assigned to this role config_template: allOf: - $ref: '#/components/schemas/BriefConfigTemplate' nullable: true parent: allOf: - $ref: '#/components/schemas/NestedDeviceRole' nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true device_count: type: integer readOnly: true default: 0 virtualmachine_count: type: integer readOnly: true default: 0 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string _depth: type: integer readOnly: true title: ' depth' required: - _depth - created - device_count - display - display_url - id - last_updated - name - slug - url - virtualmachine_count BriefVRFRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 rd: type: string nullable: true title: Route distinguisher description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 description: type: string maxLength: 200 required: - name PatchedWritableInterfaceRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' vdcs: type: array items: type: integer module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - virtual - bridge - lag - 100base-fx - 100base-lfx - 100base-tx - 100base-t1 - 1000base-bx10-d - 1000base-bx10-u - 1000base-cwdm - 1000base-cx - 1000base-dwdm - 1000base-ex - 1000base-lsx - 1000base-lx - 1000base-lx10 - 1000base-sx - 1000base-t - 1000base-tx - 1000base-zx - 2.5gbase-t - 5gbase-t - 10gbase-br-d - 10gbase-br-u - 10gbase-cu - 10gbase-cx4 - 10gbase-er - 10gbase-lr - 10gbase-lrm - 10gbase-lx4 - 10gbase-sr - 10gbase-t - 10gbase-zr - 25gbase-cr - 25gbase-er - 25gbase-lr - 25gbase-sr - 25gbase-t - 40gbase-cr4 - 40gbase-er4 - 40gbase-fr4 - 40gbase-lr4 - 40gbase-sr4 - 40gbase-sr4-bd - 50gbase-cr - 50gbase-er - 50gbase-fr - 50gbase-lr - 50gbase-sr - 100gbase-cr1 - 100gbase-cr2 - 100gbase-cr4 - 100gbase-cr10 - 100gbase-cwdm4 - 100gbase-dr - 100gbase-er4 - 100gbase-fr1 - 100gbase-lr1 - 100gbase-lr4 - 100gbase-sr1 - 100gbase-sr1.2 - 100gbase-sr2 - 100gbase-sr4 - 100gbase-sr10 - 100gbase-zr - 200gbase-cr2 - 200gbase-cr4 - 200gbase-dr4 - 200gbase-er4 - 200gbase-fr4 - 200gbase-lr4 - 200gbase-sr2 - 200gbase-sr4 - 200gbase-vr2 - 400gbase-cr4 - 400gbase-dr4 - 400gbase-er8 - 400gbase-fr4 - 400gbase-fr8 - 400gbase-lr4 - 400gbase-lr8 - 400gbase-sr4 - 400gbase-sr4_2 - 400gbase-sr8 - 400gbase-sr16 - 400gbase-vr4 - 400gbase-zr - 800gbase-cr8 - 800gbase-dr8 - 800gbase-sr8 - 800gbase-vr8 - 1.6tbase-cr8 - 1.6tbase-dr8 - 1.6tbase-dr8-2 - 100base-x-sfp - 1000base-x-gbic - 1000base-x-sfp - 2.5gbase-x-sfp - 10gbase-x-sfpp - 10gbase-x-xenpak - 10gbase-x-xfp - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 50gbase-x-sfp56 - 100gbase-x-cfp - 100gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cxp - 100gbase-x-cpak - 100gbase-x-dsfp - 100gbase-x-qsfp28 - 100gbase-x-qsfpdd - 100gbase-x-sfpdd - 200gbase-x-cfp2 - 200gbase-x-qsfp56 - 200gbase-x-qsfpdd - 400gbase-x-qsfp112 - 400gbase-x-qsfpdd - 400gbase-x-cdfp - 400gbase-x-cfp2 - 400gbase-x-cfp8 - 400gbase-x-osfp - 400gbase-x-osfp-rhs - 800gbase-x-osfp - 800gbase-x-qsfpdd - 1.6tbase-x-osfp1600 - 1.6tbase-x-osfp1600-rhs - 1.6tbase-x-qsfpdd1600 - 1000base-kx - 2.5gbase-kx - 5gbase-kr - 10gbase-kr - 10gbase-kx4 - 25gbase-kr - 40gbase-kr4 - 50gbase-kr - 100gbase-kp4 - 100gbase-kr2 - 100gbase-kr4 - 1.6tbase-kr8 - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - ieee802.11ay - ieee802.11be - ieee802.15.1 - ieee802.15.4 - other-wireless - gsm - cdma - lte - 4g - 5g - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 32gfc-sfpp - 64gfc-qsfpp - 64gfc-sfpdd - 64gfc-sfpp - 128gfc-qsfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - xdsl - docsis - moca - bpon - epon - 10g-epon - gpon - xg-pon - xgs-pon - ng-pon2 - 25g-pon - 50g-pon - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - cisco-stackwise-80 - cisco-stackwise-160 - cisco-stackwise-320 - cisco-stackwise-480 - cisco-stackwise-1t - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string description: '* `virtual` - Virtual * `bridge` - Bridge * `lag` - Link Aggregation Group (LAG) * `100base-fx` - 100BASE-FX (10/100ME) * `100base-lfx` - 100BASE-LFX (10/100ME) * `100base-tx` - 100BASE-TX (10/100ME) * `100base-t1` - 100BASE-T1 (10/100ME) * `1000base-bx10-d` - 1000BASE-BX10-D (1GE BiDi Down) * `1000base-bx10-u` - 1000BASE-BX10-U (1GE BiDi Up) * `1000base-cwdm` - 1000BASE-CWDM (1GE) * `1000base-cx` - 1000BASE-CX (1GE DAC) * `1000base-dwdm` - 1000BASE-DWDM (1GE) * `1000base-ex` - 1000BASE-EX (1GE) * `1000base-lsx` - 1000BASE-LSX (1GE) * `1000base-lx` - 1000BASE-LX (1GE) * `1000base-lx10` - 1000BASE-LX10/LH (1GE) * `1000base-sx` - 1000BASE-SX (1GE) * `1000base-t` - 1000BASE-T (1GE) * `1000base-tx` - 1000BASE-TX (1GE) * `1000base-zx` - 1000BASE-ZX (1GE) * `2.5gbase-t` - 2.5GBASE-T (2.5GE) * `5gbase-t` - 5GBASE-T (5GE) * `10gbase-br-d` - 10GBASE-BR-D (10GE BiDi Down) * `10gbase-br-u` - 10GBASE-BR-U (10GE BiDi Up) * `10gbase-cu` - 10GBASE-CU (10GE DAC Passive Twinax) * `10gbase-cx4` - 10GBASE-CX4 (10GE DAC) * `10gbase-er` - 10GBASE-ER (10GE) * `10gbase-lr` - 10GBASE-LR (10GE) * `10gbase-lrm` - 10GBASE-LRM (10GE) * `10gbase-lx4` - 10GBASE-LX4 (10GE) * `10gbase-sr` - 10GBASE-SR (10GE) * `10gbase-t` - 10GBASE-T (10GE) * `10gbase-zr` - 10GBASE-ZR (10GE) * `25gbase-cr` - 25GBASE-CR (25GE DAC) * `25gbase-er` - 25GBASE-ER (25GE) * `25gbase-lr` - 25GBASE-LR (25GE) * `25gbase-sr` - 25GBASE-SR (25GE) * `25gbase-t` - 25GBASE-T (25GE) * `40gbase-cr4` - 40GBASE-CR4 (40GE DAC) * `40gbase-er4` - 40GBASE-ER4 (40GE) * `40gbase-fr4` - 40GBASE-FR4 (40GE) * `40gbase-lr4` - 40GBASE-LR4 (40GE) * `40gbase-sr4` - 40GBASE-SR4 (40GE) * `40gbase-sr4-bd` - 40GBASE-SR4 (40GE BiDi) * `50gbase-cr` - 50GBASE-CR (50GE DAC) * `50gbase-er` - 50GBASE-ER (50GE) * `50gbase-fr` - 50GBASE-FR (50GE) * `50gbase-lr` - 50GBASE-LR (50GE) * `50gbase-sr` - 50GBASE-SR (50GE) * `100gbase-cr1` - 100GBASE-CR1 (100GE DAC) * `100gbase-cr2` - 100GBASE-CR2 (100GE DAC) * `100gbase-cr4` - 100GBASE-CR4 (100GE DAC) * `100gbase-cr10` - 100GBASE-CR10 (100GE DAC) * `100gbase-cwdm4` - 100GBASE-CWDM4 (100GE) * `100gbase-dr` - 100GBASE-DR (100GE) * `100gbase-er4` - 100GBASE-ER4 (100GE) * `100gbase-fr1` - 100GBASE-FR1 (100GE) * `100gbase-lr1` - 100GBASE-LR1 (100GE) * `100gbase-lr4` - 100GBASE-LR4 (100GE) * `100gbase-sr1` - 100GBASE-SR1 (100GE) * `100gbase-sr1.2` - 100GBASE-SR1.2 (100GE BiDi) * `100gbase-sr2` - 100GBASE-SR2 (100GE) * `100gbase-sr4` - 100GBASE-SR4 (100GE) * `100gbase-sr10` - 100GBASE-SR10 (100GE) * `100gbase-zr` - 100GBASE-ZR (100GE) * `200gbase-cr2` - 200GBASE-CR2 (200GE) * `200gbase-cr4` - 200GBASE-CR4 (200GE) * `200gbase-dr4` - 200GBASE-DR4 (200GE) * `200gbase-er4` - 200GBASE-ER4 (200GE) * `200gbase-fr4` - 200GBASE-FR4 (200GE) * `200gbase-lr4` - 200GBASE-LR4 (200GE) * `200gbase-sr2` - 200GBASE-SR2 (200GE) * `200gbase-sr4` - 200GBASE-SR4 (200GE) * `200gbase-vr2` - 200GBASE-VR2 (200GE) * `400gbase-cr4` - 400GBASE-CR4 (400GE) * `400gbase-dr4` - 400GBASE-DR4 (400GE) * `400gbase-er8` - 400GBASE-ER8 (400GE) * `400gbase-fr4` - 400GBASE-FR4 (400GE) * `400gbase-fr8` - 400GBASE-FR8 (400GE) * `400gbase-lr4` - 400GBASE-LR4 (400GE) * `400gbase-lr8` - 400GBASE-LR8 (400GE) * `400gbase-sr4` - 400GBASE-SR4 (400GE) * `400gbase-sr4_2` - 400GBASE-SR4.2 (400GE BiDi) * `400gbase-sr8` - 400GBASE-SR8 (400GE) * `400gbase-sr16` - 400GBASE-SR16 (400GE) * `400gbase-vr4` - 400GBASE-VR4 (400GE) * `400gbase-zr` - 400GBASE-ZR (400GE) * `800gbase-cr8` - 800GBASE-CR8 (800GE) * `800gbase-dr8` - 800GBASE-DR8 (800GE) * `800gbase-sr8` - 800GBASE-SR8 (800GE) * `800gbase-vr8` - 800GBASE-VR8 (800GE) * `1.6tbase-cr8` - 1.6TBASE-CR8 (1.6TE) * `1.6tbase-dr8` - 1.6TBASE-DR8 (1.6TE) * `1.6tbase-dr8-2` - 1.6TBASE-DR8-2 (1.6TE) * `100base-x-sfp` - SFP (100ME) * `1000base-x-gbic` - GBIC (1GE) * `1000base-x-sfp` - SFP (1GE) * `2.5gbase-x-sfp` - SFP (2.5GE) * `10gbase-x-sfpp` - SFP+ (10GE) * `10gbase-x-xenpak` - XENPAK (10GE) * `10gbase-x-xfp` - XFP (10GE) * `10gbase-x-x2` - X2 (10GE) * `25gbase-x-sfp28` - SFP28 (25GE) * `40gbase-x-qsfpp` - QSFP+ (40GE) * `50gbase-x-sfp28` - QSFP28 (50GE) * `50gbase-x-sfp56` - SFP56 (50GE) * `100gbase-x-cfp` - CFP (100GE) * `100gbase-x-cfp2` - CFP2 (100GE) * `100gbase-x-cfp4` - CFP4 (100GE) * `100gbase-x-cxp` - CXP (100GE) * `100gbase-x-cpak` - Cisco CPAK (100GE) * `100gbase-x-dsfp` - DSFP (100GE) * `100gbase-x-qsfp28` - QSFP28 (100GE) * `100gbase-x-qsfpdd` - QSFP-DD (100GE) * `100gbase-x-sfpdd` - SFP-DD (100GE) * `200gbase-x-cfp2` - CFP2 (200GE) * `200gbase-x-qsfp56` - QSFP56 (200GE) * `200gbase-x-qsfpdd` - QSFP-DD (200GE) * `400gbase-x-qsfp112` - QSFP112 (400GE) * `400gbase-x-qsfpdd` - QSFP-DD (400GE) * `400gbase-x-cdfp` - CDFP (400GE) * `400gbase-x-cfp2` - CFP2 (400GE) * `400gbase-x-cfp8` - CPF8 (400GE) * `400gbase-x-osfp` - OSFP (400GE) * `400gbase-x-osfp-rhs` - OSFP-RHS (400GE) * `800gbase-x-osfp` - OSFP (800GE) * `800gbase-x-qsfpdd` - QSFP-DD (800GE) * `1.6tbase-x-osfp1600` - OSFP1600 (1.6TE) * `1.6tbase-x-osfp1600-rhs` - OSFP1600-RHS (1.6TE) * `1.6tbase-x-qsfpdd1600` - QSFP-DD1600 (1.6TE) * `1000base-kx` - 1000BASE-KX (1GE) * `2.5gbase-kx` - 2.5GBASE-KX (2.5GE) * `5gbase-kr` - 5GBASE-KR (5GE) * `10gbase-kr` - 10GBASE-KR (10GE) * `10gbase-kx4` - 10GBASE-KX4 (10GE) * `25gbase-kr` - 25GBASE-KR (25GE) * `40gbase-kr4` - 40GBASE-KR4 (40GE) * `50gbase-kr` - 50GBASE-KR (50GE) * `100gbase-kp4` - 100GBASE-KP4 (100GE) * `100gbase-kr2` - 100GBASE-KR2 (100GE) * `100gbase-kr4` - 100GBASE-KR4 (100GE) * `1.6tbase-kr8` - 1.6TBASE-KR8 (1.6TE) * `ieee802.11a` - IEEE 802.11a * `ieee802.11g` - IEEE 802.11b/g * `ieee802.11n` - IEEE 802.11n (Wi-Fi 4) * `ieee802.11ac` - IEEE 802.11ac (Wi-Fi 5) * `ieee802.11ad` - IEEE 802.11ad (WiGig) * `ieee802.11ax` - IEEE 802.11ax (Wi-Fi 6) * `ieee802.11ay` - IEEE 802.11ay (WiGig) * `ieee802.11be` - IEEE 802.11be (Wi-Fi 7) * `ieee802.15.1` - IEEE 802.15.1 (Bluetooth) * `ieee802.15.4` - IEEE 802.15.4 (LR-WPAN) * `other-wireless` - Other (Wireless) * `gsm` - GSM * `cdma` - CDMA * `lte` - LTE * `4g` - 4G * `5g` - 5G * `sonet-oc3` - OC-3/STM-1 * `sonet-oc12` - OC-12/STM-4 * `sonet-oc48` - OC-48/STM-16 * `sonet-oc192` - OC-192/STM-64 * `sonet-oc768` - OC-768/STM-256 * `sonet-oc1920` - OC-1920/STM-640 * `sonet-oc3840` - OC-3840/STM-1234 * `1gfc-sfp` - SFP (1GFC) * `2gfc-sfp` - SFP (2GFC) * `4gfc-sfp` - SFP (4GFC) * `8gfc-sfpp` - SFP+ (8GFC) * `16gfc-sfpp` - SFP+ (16GFC) * `32gfc-sfp28` - SFP28 (32GFC) * `32gfc-sfpp` - SFP+ (32GFC) * `64gfc-qsfpp` - QSFP+ (64GFC) * `64gfc-sfpdd` - SFP-DD (64GFC) * `64gfc-sfpp` - SFP+ (64GFC) * `128gfc-qsfp28` - QSFP28 (128GFC) * `infiniband-sdr` - SDR (2 Gbps) * `infiniband-ddr` - DDR (4 Gbps) * `infiniband-qdr` - QDR (8 Gbps) * `infiniband-fdr10` - FDR10 (10 Gbps) * `infiniband-fdr` - FDR (13.5 Gbps) * `infiniband-edr` - EDR (25 Gbps) * `infiniband-hdr` - HDR (50 Gbps) * `infiniband-ndr` - NDR (100 Gbps) * `infiniband-xdr` - XDR (250 Gbps) * `t1` - T1 (1.544 Mbps) * `e1` - E1 (2.048 Mbps) * `t3` - T3 (45 Mbps) * `e3` - E3 (34 Mbps) * `xdsl` - xDSL * `docsis` - DOCSIS * `moca` - MoCA * `bpon` - BPON (622 Mbps / 155 Mbps) * `epon` - EPON (1 Gbps) * `10g-epon` - 10G-EPON (10 Gbps) * `gpon` - GPON (2.5 Gbps / 1.25 Gbps) * `xg-pon` - XG-PON (10 Gbps / 2.5 Gbps) * `xgs-pon` - XGS-PON (10 Gbps) * `ng-pon2` - NG-PON2 (TWDM-PON) (4x10 Gbps) * `25g-pon` - 25G-PON (25 Gbps) * `50g-pon` - 50G-PON (50 Gbps) * `cisco-stackwise` - Cisco StackWise * `cisco-stackwise-plus` - Cisco StackWise Plus * `cisco-flexstack` - Cisco FlexStack * `cisco-flexstack-plus` - Cisco FlexStack Plus * `cisco-stackwise-80` - Cisco StackWise-80 * `cisco-stackwise-160` - Cisco StackWise-160 * `cisco-stackwise-320` - Cisco StackWise-320 * `cisco-stackwise-480` - Cisco StackWise-480 * `cisco-stackwise-1t` - Cisco StackWise-1T * `juniper-vcp` - Juniper VCP * `extreme-summitstack` - Extreme SummitStack * `extreme-summitstack-128` - Extreme SummitStack-128 * `extreme-summitstack-256` - Extreme SummitStack-256 * `extreme-summitstack-512` - Extreme SummitStack-512 * `other` - Other' x-spec-enum-id: b067eb1f050c6ae9 enabled: type: boolean parent: type: integer nullable: true title: Parent interface bridge: type: integer nullable: true title: Bridge interface lag: type: integer nullable: true title: Parent LAG mtu: type: integer maximum: 65536 minimum: 1 nullable: true primary_mac_address: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefMACAddressRequest' nullable: true nullable: true speed: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true title: Speed (Kbps) duplex: enum: - half - full - auto - '' - null type: string description: '* `half` - Half * `full` - Full * `auto` - Auto' x-spec-enum-id: 368458a2b67c916b nullable: true wwn: type: string nullable: true mgmt_only: type: boolean title: Management only description: This interface is used only for out-of-band management description: type: string maxLength: 200 mode: enum: - access - tagged - tagged-all - q-in-q - '' - null type: string x-spec-enum-id: 84129b71b974ebe5 nullable: true description: 'IEEE 802.1Q tagging strategy * `access` - Access * `tagged` - Tagged * `tagged-all` - Tagged (All) * `q-in-q` - Q-in-Q (802.1ad)' rf_role: enum: - ap - station - '' - null type: string description: '* `ap` - Access point * `station` - Station' x-spec-enum-id: d2772dbea88b0fb1 nullable: true title: Wireless role rf_channel: enum: - 2.4g-1-2412-22 - 2.4g-2-2417-22 - 2.4g-3-2422-22 - 2.4g-4-2427-22 - 2.4g-5-2432-22 - 2.4g-6-2437-22 - 2.4g-7-2442-22 - 2.4g-8-2447-22 - 2.4g-9-2452-22 - 2.4g-10-2457-22 - 2.4g-11-2462-22 - 2.4g-12-2467-22 - 2.4g-13-2472-22 - 5g-32-5160-20 - 5g-34-5170-40 - 5g-36-5180-20 - 5g-38-5190-40 - 5g-40-5200-20 - 5g-42-5210-80 - 5g-44-5220-20 - 5g-46-5230-40 - 5g-48-5240-20 - 5g-50-5250-160 - 5g-52-5260-20 - 5g-54-5270-40 - 5g-56-5280-20 - 5g-58-5290-80 - 5g-60-5300-20 - 5g-62-5310-40 - 5g-64-5320-20 - 5g-100-5500-20 - 5g-102-5510-40 - 5g-104-5520-20 - 5g-106-5530-80 - 5g-108-5540-20 - 5g-110-5550-40 - 5g-112-5560-20 - 5g-114-5570-160 - 5g-116-5580-20 - 5g-118-5590-40 - 5g-120-5600-20 - 5g-122-5610-80 - 5g-124-5620-20 - 5g-126-5630-40 - 5g-128-5640-20 - 5g-132-5660-20 - 5g-134-5670-40 - 5g-136-5680-20 - 5g-138-5690-80 - 5g-140-5700-20 - 5g-142-5710-40 - 5g-144-5720-20 - 5g-149-5745-20 - 5g-151-5755-40 - 5g-153-5765-20 - 5g-155-5775-80 - 5g-157-5785-20 - 5g-159-5795-40 - 5g-161-5805-20 - 5g-163-5815-160 - 5g-165-5825-20 - 5g-167-5835-40 - 5g-169-5845-20 - 5g-171-5855-80 - 5g-173-5865-20 - 5g-175-5875-40 - 5g-177-5885-20 - 6g-1-5955-20 - 6g-3-5965-40 - 6g-5-5975-20 - 6g-7-5985-80 - 6g-9-5995-20 - 6g-11-6005-40 - 6g-13-6015-20 - 6g-15-6025-160 - 6g-17-6035-20 - 6g-19-6045-40 - 6g-21-6055-20 - 6g-23-6065-80 - 6g-25-6075-20 - 6g-27-6085-40 - 6g-29-6095-20 - 6g-31-6105-320 - 6g-33-6115-20 - 6g-35-6125-40 - 6g-37-6135-20 - 6g-39-6145-80 - 6g-41-6155-20 - 6g-43-6165-40 - 6g-45-6175-20 - 6g-47-6185-160 - 6g-49-6195-20 - 6g-51-6205-40 - 6g-53-6215-20 - 6g-55-6225-80 - 6g-57-6235-20 - 6g-59-6245-40 - 6g-61-6255-20 - 6g-65-6275-20 - 6g-67-6285-40 - 6g-69-6295-20 - 6g-71-6305-80 - 6g-73-6315-20 - 6g-75-6325-40 - 6g-77-6335-20 - 6g-79-6345-160 - 6g-81-6355-20 - 6g-83-6365-40 - 6g-85-6375-20 - 6g-87-6385-80 - 6g-89-6395-20 - 6g-91-6405-40 - 6g-93-6415-20 - 6g-95-6425-320 - 6g-97-6435-20 - 6g-99-6445-40 - 6g-101-6455-20 - 6g-103-6465-80 - 6g-105-6475-20 - 6g-107-6485-40 - 6g-109-6495-20 - 6g-111-6505-160 - 6g-113-6515-20 - 6g-115-6525-40 - 6g-117-6535-20 - 6g-119-6545-80 - 6g-121-6555-20 - 6g-123-6565-40 - 6g-125-6575-20 - 6g-129-6595-20 - 6g-131-6605-40 - 6g-133-6615-20 - 6g-135-6625-80 - 6g-137-6635-20 - 6g-139-6645-40 - 6g-141-6655-20 - 6g-143-6665-160 - 6g-145-6675-20 - 6g-147-6685-40 - 6g-149-6695-20 - 6g-151-6705-80 - 6g-153-6715-20 - 6g-155-6725-40 - 6g-157-6735-20 - 6g-159-6745-320 - 6g-161-6755-20 - 6g-163-6765-40 - 6g-165-6775-20 - 6g-167-6785-80 - 6g-169-6795-20 - 6g-171-6805-40 - 6g-173-6815-20 - 6g-175-6825-160 - 6g-177-6835-20 - 6g-179-6845-40 - 6g-181-6855-20 - 6g-183-6865-80 - 6g-185-6875-20 - 6g-187-6885-40 - 6g-189-6895-20 - 6g-193-6915-20 - 6g-195-6925-40 - 6g-197-6935-20 - 6g-199-6945-80 - 6g-201-6955-20 - 6g-203-6965-40 - 6g-205-6975-20 - 6g-207-6985-160 - 6g-209-6995-20 - 6g-211-7005-40 - 6g-213-7015-20 - 6g-215-7025-80 - 6g-217-7035-20 - 6g-219-7045-40 - 6g-221-7055-20 - 6g-225-7075-20 - 6g-227-7085-40 - 6g-229-7095-20 - 6g-233-7115-20 - 60g-1-58320-2160 - 60g-2-60480-2160 - 60g-3-62640-2160 - 60g-4-64800-2160 - 60g-5-66960-2160 - 60g-6-69120-2160 - 60g-9-59400-4320 - 60g-10-61560-4320 - 60g-11-63720-4320 - 60g-12-65880-4320 - 60g-13-68040-4320 - 60g-17-60480-6480 - 60g-18-62640-6480 - 60g-19-64800-6480 - 60g-20-66960-6480 - 60g-25-61560-6480 - 60g-26-63720-6480 - 60g-27-65880-6480 - '' - null type: string description: '* `2.4g-1-2412-22` - 1 (2412 MHz) * `2.4g-2-2417-22` - 2 (2417 MHz) * `2.4g-3-2422-22` - 3 (2422 MHz) * `2.4g-4-2427-22` - 4 (2427 MHz) * `2.4g-5-2432-22` - 5 (2432 MHz) * `2.4g-6-2437-22` - 6 (2437 MHz) * `2.4g-7-2442-22` - 7 (2442 MHz) * `2.4g-8-2447-22` - 8 (2447 MHz) * `2.4g-9-2452-22` - 9 (2452 MHz) * `2.4g-10-2457-22` - 10 (2457 MHz) * `2.4g-11-2462-22` - 11 (2462 MHz) * `2.4g-12-2467-22` - 12 (2467 MHz) * `2.4g-13-2472-22` - 13 (2472 MHz) * `5g-32-5160-20` - 32 (5160/20 MHz) * `5g-34-5170-40` - 34 (5170/40 MHz) * `5g-36-5180-20` - 36 (5180/20 MHz) * `5g-38-5190-40` - 38 (5190/40 MHz) * `5g-40-5200-20` - 40 (5200/20 MHz) * `5g-42-5210-80` - 42 (5210/80 MHz) * `5g-44-5220-20` - 44 (5220/20 MHz) * `5g-46-5230-40` - 46 (5230/40 MHz) * `5g-48-5240-20` - 48 (5240/20 MHz) * `5g-50-5250-160` - 50 (5250/160 MHz) * `5g-52-5260-20` - 52 (5260/20 MHz) * `5g-54-5270-40` - 54 (5270/40 MHz) * `5g-56-5280-20` - 56 (5280/20 MHz) * `5g-58-5290-80` - 58 (5290/80 MHz) * `5g-60-5300-20` - 60 (5300/20 MHz) * `5g-62-5310-40` - 62 (5310/40 MHz) * `5g-64-5320-20` - 64 (5320/20 MHz) * `5g-100-5500-20` - 100 (5500/20 MHz) * `5g-102-5510-40` - 102 (5510/40 MHz) * `5g-104-5520-20` - 104 (5520/20 MHz) * `5g-106-5530-80` - 106 (5530/80 MHz) * `5g-108-5540-20` - 108 (5540/20 MHz) * `5g-110-5550-40` - 110 (5550/40 MHz) * `5g-112-5560-20` - 112 (5560/20 MHz) * `5g-114-5570-160` - 114 (5570/160 MHz) * `5g-116-5580-20` - 116 (5580/20 MHz) * `5g-118-5590-40` - 118 (5590/40 MHz) * `5g-120-5600-20` - 120 (5600/20 MHz) * `5g-122-5610-80` - 122 (5610/80 MHz) * `5g-124-5620-20` - 124 (5620/20 MHz) * `5g-126-5630-40` - 126 (5630/40 MHz) * `5g-128-5640-20` - 128 (5640/20 MHz) * `5g-132-5660-20` - 132 (5660/20 MHz) * `5g-134-5670-40` - 134 (5670/40 MHz) * `5g-136-5680-20` - 136 (5680/20 MHz) * `5g-138-5690-80` - 138 (5690/80 MHz) * `5g-140-5700-20` - 140 (5700/20 MHz) * `5g-142-5710-40` - 142 (5710/40 MHz) * `5g-144-5720-20` - 144 (5720/20 MHz) * `5g-149-5745-20` - 149 (5745/20 MHz) * `5g-151-5755-40` - 151 (5755/40 MHz) * `5g-153-5765-20` - 153 (5765/20 MHz) * `5g-155-5775-80` - 155 (5775/80 MHz) * `5g-157-5785-20` - 157 (5785/20 MHz) * `5g-159-5795-40` - 159 (5795/40 MHz) * `5g-161-5805-20` - 161 (5805/20 MHz) * `5g-163-5815-160` - 163 (5815/160 MHz) * `5g-165-5825-20` - 165 (5825/20 MHz) * `5g-167-5835-40` - 167 (5835/40 MHz) * `5g-169-5845-20` - 169 (5845/20 MHz) * `5g-171-5855-80` - 171 (5855/80 MHz) * `5g-173-5865-20` - 173 (5865/20 MHz) * `5g-175-5875-40` - 175 (5875/40 MHz) * `5g-177-5885-20` - 177 (5885/20 MHz) * `6g-1-5955-20` - 1 (5955/20 MHz) * `6g-3-5965-40` - 3 (5965/40 MHz) * `6g-5-5975-20` - 5 (5975/20 MHz) * `6g-7-5985-80` - 7 (5985/80 MHz) * `6g-9-5995-20` - 9 (5995/20 MHz) * `6g-11-6005-40` - 11 (6005/40 MHz) * `6g-13-6015-20` - 13 (6015/20 MHz) * `6g-15-6025-160` - 15 (6025/160 MHz) * `6g-17-6035-20` - 17 (6035/20 MHz) * `6g-19-6045-40` - 19 (6045/40 MHz) * `6g-21-6055-20` - 21 (6055/20 MHz) * `6g-23-6065-80` - 23 (6065/80 MHz) * `6g-25-6075-20` - 25 (6075/20 MHz) * `6g-27-6085-40` - 27 (6085/40 MHz) * `6g-29-6095-20` - 29 (6095/20 MHz) * `6g-31-6105-320` - 31 (6105/320 MHz) * `6g-33-6115-20` - 33 (6115/20 MHz) * `6g-35-6125-40` - 35 (6125/40 MHz) * `6g-37-6135-20` - 37 (6135/20 MHz) * `6g-39-6145-80` - 39 (6145/80 MHz) * `6g-41-6155-20` - 41 (6155/20 MHz) * `6g-43-6165-40` - 43 (6165/40 MHz) * `6g-45-6175-20` - 45 (6175/20 MHz) * `6g-47-6185-160` - 47 (6185/160 MHz) * `6g-49-6195-20` - 49 (6195/20 MHz) * `6g-51-6205-40` - 51 (6205/40 MHz) * `6g-53-6215-20` - 53 (6215/20 MHz) * `6g-55-6225-80` - 55 (6225/80 MHz) * `6g-57-6235-20` - 57 (6235/20 MHz) * `6g-59-6245-40` - 59 (6245/40 MHz) * `6g-61-6255-20` - 61 (6255/20 MHz) * `6g-65-6275-20` - 65 (6275/20 MHz) * `6g-67-6285-40` - 67 (6285/40 MHz) * `6g-69-6295-20` - 69 (6295/20 MHz) * `6g-71-6305-80` - 71 (6305/80 MHz) * `6g-73-6315-20` - 73 (6315/20 MHz) * `6g-75-6325-40` - 75 (6325/40 MHz) * `6g-77-6335-20` - 77 (6335/20 MHz) * `6g-79-6345-160` - 79 (6345/160 MHz) * `6g-81-6355-20` - 81 (6355/20 MHz) * `6g-83-6365-40` - 83 (6365/40 MHz) * `6g-85-6375-20` - 85 (6375/20 MHz) * `6g-87-6385-80` - 87 (6385/80 MHz) * `6g-89-6395-20` - 89 (6395/20 MHz) * `6g-91-6405-40` - 91 (6405/40 MHz) * `6g-93-6415-20` - 93 (6415/20 MHz) * `6g-95-6425-320` - 95 (6425/320 MHz) * `6g-97-6435-20` - 97 (6435/20 MHz) * `6g-99-6445-40` - 99 (6445/40 MHz) * `6g-101-6455-20` - 101 (6455/20 MHz) * `6g-103-6465-80` - 103 (6465/80 MHz) * `6g-105-6475-20` - 105 (6475/20 MHz) * `6g-107-6485-40` - 107 (6485/40 MHz) * `6g-109-6495-20` - 109 (6495/20 MHz) * `6g-111-6505-160` - 111 (6505/160 MHz) * `6g-113-6515-20` - 113 (6515/20 MHz) * `6g-115-6525-40` - 115 (6525/40 MHz) * `6g-117-6535-20` - 117 (6535/20 MHz) * `6g-119-6545-80` - 119 (6545/80 MHz) * `6g-121-6555-20` - 121 (6555/20 MHz) * `6g-123-6565-40` - 123 (6565/40 MHz) * `6g-125-6575-20` - 125 (6575/20 MHz) * `6g-129-6595-20` - 129 (6595/20 MHz) * `6g-131-6605-40` - 131 (6605/40 MHz) * `6g-133-6615-20` - 133 (6615/20 MHz) * `6g-135-6625-80` - 135 (6625/80 MHz) * `6g-137-6635-20` - 137 (6635/20 MHz) * `6g-139-6645-40` - 139 (6645/40 MHz) * `6g-141-6655-20` - 141 (6655/20 MHz) * `6g-143-6665-160` - 143 (6665/160 MHz) * `6g-145-6675-20` - 145 (6675/20 MHz) * `6g-147-6685-40` - 147 (6685/40 MHz) * `6g-149-6695-20` - 149 (6695/20 MHz) * `6g-151-6705-80` - 151 (6705/80 MHz) * `6g-153-6715-20` - 153 (6715/20 MHz) * `6g-155-6725-40` - 155 (6725/40 MHz) * `6g-157-6735-20` - 157 (6735/20 MHz) * `6g-159-6745-320` - 159 (6745/320 MHz) * `6g-161-6755-20` - 161 (6755/20 MHz) * `6g-163-6765-40` - 163 (6765/40 MHz) * `6g-165-6775-20` - 165 (6775/20 MHz) * `6g-167-6785-80` - 167 (6785/80 MHz) * `6g-169-6795-20` - 169 (6795/20 MHz) * `6g-171-6805-40` - 171 (6805/40 MHz) * `6g-173-6815-20` - 173 (6815/20 MHz) * `6g-175-6825-160` - 175 (6825/160 MHz) * `6g-177-6835-20` - 177 (6835/20 MHz) * `6g-179-6845-40` - 179 (6845/40 MHz) * `6g-181-6855-20` - 181 (6855/20 MHz) * `6g-183-6865-80` - 183 (6865/80 MHz) * `6g-185-6875-20` - 185 (6875/20 MHz) * `6g-187-6885-40` - 187 (6885/40 MHz) * `6g-189-6895-20` - 189 (6895/20 MHz) * `6g-193-6915-20` - 193 (6915/20 MHz) * `6g-195-6925-40` - 195 (6925/40 MHz) * `6g-197-6935-20` - 197 (6935/20 MHz) * `6g-199-6945-80` - 199 (6945/80 MHz) * `6g-201-6955-20` - 201 (6955/20 MHz) * `6g-203-6965-40` - 203 (6965/40 MHz) * `6g-205-6975-20` - 205 (6975/20 MHz) * `6g-207-6985-160` - 207 (6985/160 MHz) * `6g-209-6995-20` - 209 (6995/20 MHz) * `6g-211-7005-40` - 211 (7005/40 MHz) * `6g-213-7015-20` - 213 (7015/20 MHz) * `6g-215-7025-80` - 215 (7025/80 MHz) * `6g-217-7035-20` - 217 (7035/20 MHz) * `6g-219-7045-40` - 219 (7045/40 MHz) * `6g-221-7055-20` - 221 (7055/20 MHz) * `6g-225-7075-20` - 225 (7075/20 MHz) * `6g-227-7085-40` - 227 (7085/40 MHz) * `6g-229-7095-20` - 229 (7095/20 MHz) * `6g-233-7115-20` - 233 (7115/20 MHz) * `60g-1-58320-2160` - 1 (58.32/2.16 GHz) * `60g-2-60480-2160` - 2 (60.48/2.16 GHz) * `60g-3-62640-2160` - 3 (62.64/2.16 GHz) * `60g-4-64800-2160` - 4 (64.80/2.16 GHz) * `60g-5-66960-2160` - 5 (66.96/2.16 GHz) * `60g-6-69120-2160` - 6 (69.12/2.16 GHz) * `60g-9-59400-4320` - 9 (59.40/4.32 GHz) * `60g-10-61560-4320` - 10 (61.56/4.32 GHz) * `60g-11-63720-4320` - 11 (63.72/4.32 GHz) * `60g-12-65880-4320` - 12 (65.88/4.32 GHz) * `60g-13-68040-4320` - 13 (68.04/4.32 GHz) * `60g-17-60480-6480` - 17 (60.48/6.48 GHz) * `60g-18-62640-6480` - 18 (62.64/6.48 GHz) * `60g-19-64800-6480` - 19 (64.80/6.48 GHz) * `60g-20-66960-6480` - 20 (66.96/6.48 GHz) * `60g-25-61560-6480` - 25 (61.56/8.64 GHz) * `60g-26-63720-6480` - 26 (63.72/8.64 GHz) * `60g-27-65880-6480` - 27 (65.88/8.64 GHz)' x-spec-enum-id: 70cf66176c475063 nullable: true title: Wireless channel poe_mode: enum: - pd - pse - '' - null type: string description: '* `pd` - PD * `pse` - PSE' x-spec-enum-id: 2f2fe6dcdc7772bd nullable: true poe_type: enum: - type1-ieee802.3af - type2-ieee802.3at - type3-ieee802.3bt - type4-ieee802.3bt - passive-24v-2pair - passive-24v-4pair - passive-48v-2pair - passive-48v-4pair - '' - null type: string description: '* `type1-ieee802.3af` - 802.3af (Type 1) * `type2-ieee802.3at` - 802.3at (Type 2) * `type3-ieee802.3bt` - 802.3bt (Type 3) * `type4-ieee802.3bt` - 802.3bt (Type 4) * `passive-24v-2pair` - Passive 24V (2-pair) * `passive-24v-4pair` - Passive 24V (4-pair) * `passive-48v-2pair` - Passive 48V (2-pair) * `passive-48v-4pair` - Passive 48V (4-pair)' x-spec-enum-id: 5473d57885f237ab nullable: true rf_channel_frequency: type: number format: double maximum: 100000 minimum: -100000 exclusiveMaximum: true exclusiveMinimum: true nullable: true title: Channel frequency (MHz) description: Populated by selected channel (if set) rf_channel_width: type: number format: double maximum: 10000 minimum: -10000 exclusiveMaximum: true exclusiveMinimum: true nullable: true title: Channel width (MHz) description: Populated by selected channel (if set) tx_power: type: integer maximum: 127 minimum: -40 nullable: true title: Transmit power (dBm) untagged_vlan: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANRequest' nullable: true nullable: true tagged_vlans: type: array items: type: integer qinq_svlan: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANRequest' nullable: true nullable: true vlan_translation_policy: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANTranslationPolicyRequest' nullable: true nullable: true mark_connected: type: boolean description: Treat as if a cable is connected wireless_lans: type: array items: type: integer vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PatchedRackRoleRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string minLength: 1 pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} DeviceBayTemplate: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device_type: $ref: '#/components/schemas/BriefDeviceType' name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 description: type: string maxLength: 200 created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - device_type - display - id - last_updated - name - url WritableRackRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 facility_id: type: string nullable: true maxLength: 50 site: oneOf: - type: integer - $ref: '#/components/schemas/BriefSiteRequest' location: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefLocationRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - reserved - available - planned - active - deprecated type: string description: '* `reserved` - Reserved * `available` - Available * `planned` - Planned * `active` - Active * `deprecated` - Deprecated' x-spec-enum-id: 76eea4eef8804bcb role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackRoleRequest' nullable: true nullable: true serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this rack maxLength: 50 rack_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRackTypeRequest' nullable: true nullable: true form_factor: enum: - 2-post-frame - 4-post-frame - 4-post-cabinet - wall-frame - wall-frame-vertical - wall-cabinet - wall-cabinet-vertical - '' - null type: string 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)' x-spec-enum-id: 8a902fde21d48841 nullable: true width: enum: - 10 - 19 - 21 - 23 type: integer x-spec-enum-id: 9b322795f297a9c3 description: 'Rail-to-rail width * `10` - 10 inches * `19` - 19 inches * `21` - 21 inches * `23` - 23 inches' minimum: 0 maximum: 32767 u_height: type: integer maximum: 100 minimum: 1 title: Height (U) description: Height in rack units starting_unit: type: integer maximum: 32767 minimum: 1 description: Starting unit for rack weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true max_weight: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Maximum load capacity for the rack weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true desc_units: type: boolean title: Descending units description: Units are numbered top-to-bottom outer_width: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (width) outer_height: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (height) outer_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Outer dimension of rack (depth) outer_unit: enum: - mm - in - '' - null type: string description: '* `mm` - Millimeters * `in` - Inches' x-spec-enum-id: 3d701848b66312c3 nullable: true mounting_depth: type: integer maximum: 32767 minimum: 0 nullable: true description: Maximum depth of a mounted device, in millimeters. For four-post racks, this is the distance between the front and rear rails. airflow: enum: - front-to-rear - rear-to-front - '' - null type: string description: '* `front-to-rear` - Front to rear * `rear-to-front` - Rear to front' x-spec-enum-id: a784734d07ef1b3c nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - site DeviceTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' default_platform: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefPlatformRequest' nullable: true nullable: true model: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ part_number: type: string description: Discrete part number (optional) maxLength: 50 u_height: type: number format: double maximum: 1000 minimum: 0 exclusiveMaximum: true default: 1.0 title: Position (U) exclude_from_utilization: type: boolean description: Devices of this type are excluded when calculating rack utilization. is_full_depth: type: boolean description: Device consumes both front and rear rack faces. subdevice_role: enum: - parent - child - '' - null type: string description: '* `parent` - Parent * `child` - Child' x-spec-enum-id: 65a61d5e1deb4a24 nullable: true airflow: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - rear-to-side - bottom-to-top - top-to-bottom - passive - mixed - '' - null type: string 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' x-spec-enum-id: 11cb3d363b41ba9e nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true front_image: type: string format: binary nullable: true rear_image: type: string format: binary nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - manufacturer - model - slug InventoryItemRoleRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string minLength: 1 pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug ModuleTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: profile: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeProfileRequest' nullable: true nullable: true manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' model: type: string minLength: 1 maxLength: 100 part_number: type: string description: Discrete part number (optional) maxLength: 50 airflow: enum: - front-to-rear - rear-to-front - left-to-right - right-to-left - side-to-rear - passive - '' - null type: string 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' x-spec-enum-id: 5ad4e700c656b09d nullable: true weight: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true weight_unit: enum: - kg - g - lb - oz - '' - null type: string description: '* `kg` - Kilograms * `g` - Grams * `lb` - Pounds * `oz` - Ounces' x-spec-enum-id: 2235ce3f404afbc0 nullable: true description: type: string maxLength: 200 attributes: nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - manufacturer - model DeviceRoleRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string minLength: 1 pattern: ^[0-9a-f]{6}$ maxLength: 6 vm_role: type: boolean description: Virtual machines may be assigned to this role config_template: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefConfigTemplateRequest' nullable: true nullable: true parent: allOf: - $ref: '#/components/schemas/NestedDeviceRoleRequest' nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string required: - name - slug InventoryItem: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' parent: type: integer nullable: true name: type: string maxLength: 64 label: type: string description: Physical label maxLength: 64 status: type: object properties: value: enum: - offline - active - planned - staged - failed - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning' x-spec-enum-id: 545817eb4c4f2ae4 label: type: string enum: - Offline - Active - Planned - Staged - Failed - Decommissioning role: allOf: - $ref: '#/components/schemas/BriefInventoryItemRole' nullable: true manufacturer: allOf: - $ref: '#/components/schemas/BriefManufacturer' nullable: true part_id: type: string description: Manufacturer-assigned part identifier maxLength: 50 serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this item maxLength: 50 discovered: type: boolean description: This item was automatically discovered description: type: string maxLength: 200 component_type: type: string nullable: true component_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true component: readOnly: true nullable: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true _depth: type: integer readOnly: true title: ' depth' required: - _depth - component - created - device - display - display_url - id - last_updated - name - url BriefModuleRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module_bay: $ref: '#/components/schemas/NestedModuleBayRequest' required: - device - module_bay WritableRegionRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ parent: type: integer nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string required: - name - slug PowerOutletTemplate: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device_type: allOf: - $ref: '#/components/schemas/BriefDeviceType' nullable: true module_type: allOf: - $ref: '#/components/schemas/BriefModuleType' nullable: true name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - iec-60320-c5 - iec-60320-c7 - iec-60320-c13 - iec-60320-c15 - iec-60320-c17 - iec-60320-c19 - iec-60320-c21 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15r - nema-5-15r - nema-5-20r - nema-5-30r - nema-5-50r - nema-6-15r - nema-6-20r - nema-6-30r - nema-6-50r - nema-10-30r - nema-10-50r - nema-14-20r - nema-14-30r - nema-14-50r - nema-14-60r - nema-15-15r - nema-15-20r - nema-15-30r - nema-15-50r - nema-15-60r - nema-l1-15r - nema-l5-15r - nema-l5-20r - nema-l5-30r - nema-l5-50r - nema-l6-15r - nema-l6-20r - nema-l6-30r - nema-l6-50r - nema-l10-30r - nema-l14-20r - nema-l14-30r - nema-l14-50r - nema-l14-60r - nema-l15-20r - nema-l15-30r - nema-l15-50r - nema-l15-60r - nema-l21-20r - nema-l21-30r - nema-l22-20r - nema-l22-30r - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ita-e - ita-f - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - ita-multistandard - usb-a - usb-micro-b - usb-c - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - eaton-c39 - hdot-cx - saf-d-grid - neutrik-powercon-20a - neutrik-powercon-32a - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c5` - C5 * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 * `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15r` - NEMA 1-15R * `nema-5-15r` - NEMA 5-15R * `nema-5-20r` - NEMA 5-20R * `nema-5-30r` - NEMA 5-30R * `nema-5-50r` - NEMA 5-50R * `nema-6-15r` - NEMA 6-15R * `nema-6-20r` - NEMA 6-20R * `nema-6-30r` - NEMA 6-30R * `nema-6-50r` - NEMA 6-50R * `nema-10-30r` - NEMA 10-30R * `nema-10-50r` - NEMA 10-50R * `nema-14-20r` - NEMA 14-20R * `nema-14-30r` - NEMA 14-30R * `nema-14-50r` - NEMA 14-50R * `nema-14-60r` - NEMA 14-60R * `nema-15-15r` - NEMA 15-15R * `nema-15-20r` - NEMA 15-20R * `nema-15-30r` - NEMA 15-30R * `nema-15-50r` - NEMA 15-50R * `nema-15-60r` - NEMA 15-60R * `nema-l1-15r` - NEMA L1-15R * `nema-l5-15r` - NEMA L5-15R * `nema-l5-20r` - NEMA L5-20R * `nema-l5-30r` - NEMA L5-30R * `nema-l5-50r` - NEMA L5-50R * `nema-l6-15r` - NEMA L6-15R * `nema-l6-20r` - NEMA L6-20R * `nema-l6-30r` - NEMA L6-30R * `nema-l6-50r` - NEMA L6-50R * `nema-l10-30r` - NEMA L10-30R * `nema-l14-20r` - NEMA L14-20R * `nema-l14-30r` - NEMA L14-30R * `nema-l14-50r` - NEMA L14-50R * `nema-l14-60r` - NEMA L14-60R * `nema-l15-20r` - NEMA L15-20R * `nema-l15-30r` - NEMA L15-30R * `nema-l15-50r` - NEMA L15-50R * `nema-l15-60r` - NEMA L15-60R * `nema-l21-20r` - NEMA L21-20R * `nema-l21-30r` - NEMA L21-30R * `nema-l22-20r` - NEMA L22-20R * `nema-l22-30r` - NEMA L22-30R * `CS6360C` - CS6360C * `CS6364C` - CS6364C * `CS8164C` - CS8164C * `CS8264C` - CS8264C * `CS8364C` - CS8364C * `CS8464C` - CS8464C * `ita-e` - ITA Type E (CEE 7/5) * `ita-f` - ITA Type F (CEE 7/3) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `ita-multistandard` - ITA Multistandard * `usb-a` - USB Type A * `usb-micro-b` - USB Micro B * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 * `hdot-cx` - HDOT Cx * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20a` - Neutrik powerCON (20A) * `neutrik-powercon-32a` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: db3e4eb2b93615f8 label: type: string enum: - C5 - C7 - C13 - C15 - C17 - C19 - C21 - P+N+E 4H - P+N+E 6H - P+N+E 9H - 2P+E 4H - 2P+E 6H - 2P+E 9H - 3P+E 4H - 3P+E 6H - 3P+E 9H - 3P+N+E 4H - 3P+N+E 6H - 3P+N+E 9H - IEC 60906-1 - 2P+T 10A (NBR 14136) - 2P+T 20A (NBR 14136) - NEMA 1-15R - NEMA 5-15R - NEMA 5-20R - NEMA 5-30R - NEMA 5-50R - NEMA 6-15R - NEMA 6-20R - NEMA 6-30R - NEMA 6-50R - NEMA 10-30R - NEMA 10-50R - NEMA 14-20R - NEMA 14-30R - NEMA 14-50R - NEMA 14-60R - NEMA 15-15R - NEMA 15-20R - NEMA 15-30R - NEMA 15-50R - NEMA 15-60R - NEMA L1-15R - NEMA L5-15R - NEMA L5-20R - NEMA L5-30R - NEMA L5-50R - NEMA L6-15R - NEMA L6-20R - NEMA L6-30R - NEMA L6-50R - NEMA L10-30R - NEMA L14-20R - NEMA L14-30R - NEMA L14-50R - NEMA L14-60R - NEMA L15-20R - NEMA L15-30R - NEMA L15-50R - NEMA L15-60R - NEMA L21-20R - NEMA L21-30R - NEMA L22-20R - NEMA L22-30R - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ITA Type E (CEE 7/5) - ITA Type F (CEE 7/3) - ITA Type G (BS 1363) - ITA Type H - ITA Type I - ITA Type J - ITA Type K - ITA Type L (CEI 23-50) - ITA Type M (BS 546) - ITA Type N - ITA Type O - ITA Multistandard - USB Type A - USB Micro B - USB Type C - Molex Micro-Fit 1x2 - Molex Micro-Fit 2x2 - Molex Micro-Fit 2x3 - Molex Micro-Fit 2x4 - DC Terminal - Eaton C39 - HDOT Cx - Saf-D-Grid - Neutrik powerCON (20A) - Neutrik powerCON (32A) - Neutrik powerCON TRUE1 - Neutrik powerCON TRUE1 TOP - Ubiquiti SmartPower - Hardwired - Other nullable: true color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 power_port: allOf: - $ref: '#/components/schemas/BriefPowerPortTemplate' nullable: true feed_leg: type: object properties: value: enum: - A - B - C - '' - null type: string description: '* `A` - A * `B` - B * `C` - C' x-spec-enum-id: a4902339df0b7c06 label: type: string enum: - A - B - C nullable: true description: type: string maxLength: 200 created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - id - last_updated - name - url PaginatedSiteList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Site' ModuleTypeProfile: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 schema: nullable: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - name - url BriefRackTypeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: manufacturer: oneOf: - type: integer - $ref: '#/components/schemas/BriefManufacturerRequest' model: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - manufacturer - model - slug NestedDeviceRequest: type: object 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.' properties: name: type: string nullable: true maxLength: 64 PaginatedRackReservationList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/RackReservation' WritableVirtualDeviceContextRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 64 device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' identifier: type: integer maximum: 32767 minimum: 0 nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true primary_ip4: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true primary_ip6: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true status: enum: - active - planned - offline type: string description: '* `active` - Active * `planned` - Planned * `offline` - Offline' x-spec-enum-id: 0e2c0919d51b83cb description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name - status InventoryItemRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' parent: type: integer nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 status: enum: - offline - active - planned - staged - failed - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning' x-spec-enum-id: 545817eb4c4f2ae4 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefInventoryItemRoleRequest' nullable: true nullable: true manufacturer: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefManufacturerRequest' nullable: true nullable: true part_id: type: string description: Manufacturer-assigned part identifier maxLength: 50 serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this item maxLength: 50 discovered: type: boolean description: This item was automatically discovered description: type: string maxLength: 200 component_type: type: string nullable: true component_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name NestedSiteGroup: type: object 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.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ _depth: type: integer readOnly: true title: ' depth' required: - _depth - display - display_url - id - name - slug - url RearPort: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' module: allOf: - $ref: '#/components/schemas/BriefModule' nullable: true name: type: string maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c label: type: string enum: - 8P8C - 8P6C - 8P4C - 8P2C - 6P6C - 6P4C - 6P2C - 4P4C - 4P2C - GG45 - TERA 4P - TERA 2P - TERA 1P - 110 Punch - BNC - F Connector - N Connector - MRJ21 - FC - FC/PC - FC/UPC - FC/APC - LC - LC/PC - LC/UPC - LC/APC - LSH - LSH/PC - LSH/UPC - LSH/APC - LX.5 - LX.5/PC - LX.5/UPC - LX.5/APC - MPO - MTRJ - SC - SC/PC - SC/UPC - SC/APC - ST - CS - SN - SMA 905 - SMA 906 - URM-P2 - URM-P4 - URM-P8 - Splice - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB Micro AB - Other color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 front_ports: type: array items: $ref: '#/components/schemas/RearPortMapping' description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected cable: allOf: - $ref: '#/components/schemas/BriefCable' readOnly: true nullable: true cable_end: type: string readOnly: true link_peers: type: array items: {} readOnly: true link_peers_type: type: string description: Return the type of the peer link terminations, or None. readOnly: true nullable: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - cable - cable_end - created - device - display - display_url - id - last_updated - link_peers - link_peers_type - name - type - url VirtualChassisRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 64 domain: type: string maxLength: 30 master: allOf: - $ref: '#/components/schemas/NestedDeviceRequest' nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name PaginatedRegionList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Region' PatchedModuleBayRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 installed_module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true label: type: string description: Physical label maxLength: 64 position: type: string description: Identifier to reference when renaming installed components maxLength: 30 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PowerFeed: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true power_panel: $ref: '#/components/schemas/BriefPowerPanel' rack: allOf: - $ref: '#/components/schemas/BriefRack' nullable: true name: type: string maxLength: 100 status: type: object properties: value: enum: - offline - active - planned - failed type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `failed` - Failed' x-spec-enum-id: ec530572dc778583 label: type: string enum: - Offline - Active - Planned - Failed type: type: object properties: value: enum: - primary - redundant type: string description: '* `primary` - Primary * `redundant` - Redundant' x-spec-enum-id: 093a164236819eb8 label: type: string enum: - Primary - Redundant supply: type: object properties: value: enum: - ac - dc type: string description: '* `ac` - AC * `dc` - DC' x-spec-enum-id: 1b6d99616ca6412b label: type: string enum: - AC - DC phase: type: object properties: value: enum: - single-phase - three-phase type: string description: '* `single-phase` - Single phase * `three-phase` - Three-phase' x-spec-enum-id: 994bc0696f4df57f label: type: string enum: - Single phase - Three-phase voltage: type: integer maximum: 32767 minimum: -32768 amperage: type: integer maximum: 32767 minimum: 1 max_utilization: type: integer maximum: 100 minimum: 1 description: Maximum permissible draw (percentage) mark_connected: type: boolean description: Treat as if a cable is connected cable: allOf: - $ref: '#/components/schemas/BriefCable' readOnly: true nullable: true cable_end: type: string readOnly: true link_peers: type: array items: {} readOnly: true link_peers_type: type: string description: Return the type of the peer link terminations, or None. readOnly: true nullable: true connected_endpoints: type: array items: {} nullable: true readOnly: true connected_endpoints_type: type: string readOnly: true nullable: true connected_endpoints_reachable: type: boolean readOnly: true description: type: string maxLength: 200 tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - cable - cable_end - connected_endpoints - connected_endpoints_reachable - connected_endpoints_type - created - display - display_url - id - last_updated - link_peers - link_peers_type - name - power_panel - url FrontPortMapping: type: object properties: position: type: integer rear_port: type: integer rear_port_position: type: integer maximum: 1024 minimum: 1 default: 1 required: - position - rear_port ConsolePortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 speed: enum: - 1200 - 2400 - 4800 - 9600 - 19200 - 38400 - 57600 - 115200 - null type: integer description: '* `1200` - 1200 bps * `2400` - 2400 bps * `4800` - 4800 bps * `9600` - 9600 bps * `19200` - 19.2 kbps * `38400` - 38.4 kbps * `57600` - 57.6 kbps * `115200` - 115.2 kbps' x-spec-enum-id: ab6d9635c131a378 nullable: true description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name RackUnit: type: object description: A rack unit is an abstraction formed by the set (rack, position, face); it does not exist as a row in the database. properties: id: type: number format: double maximum: 1000 minimum: -1000 exclusiveMaximum: true exclusiveMinimum: true readOnly: true name: type: string readOnly: true face: type: object properties: value: enum: - front - rear type: string description: '* `front` - Front * `rear` - Rear' x-spec-enum-id: d2fb9b3f75158b83 label: type: string enum: - Front - Rear readOnly: true device: allOf: - $ref: '#/components/schemas/BriefDevice' readOnly: true occupied: type: boolean readOnly: true display: type: string readOnly: true required: - device - display - face - id - name - occupied RackReservation: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true rack: $ref: '#/components/schemas/BriefRack' units: type: array items: type: integer maximum: 32767 minimum: 0 status: type: object properties: value: enum: - pending - active - stale type: string description: '* `pending` - Pending * `active` - Active * `stale` - Stale' x-spec-enum-id: ed6038a4deee151c label: type: string enum: - Pending - Active - Stale created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true user: $ref: '#/components/schemas/BriefUser' tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} required: - created - description - display - display_url - id - last_updated - rack - units - url - user BriefRIR: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 aggregate_count: type: integer format: int64 readOnly: true required: - aggregate_count - display - id - name - slug - url PowerPortTemplate: type: object 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)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device_type: allOf: - $ref: '#/components/schemas/BriefDeviceType' nullable: true module_type: allOf: - $ref: '#/components/schemas/BriefModuleType' nullable: true name: type: string description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - iec-60320-c6 - iec-60320-c8 - iec-60320-c14 - iec-60320-c16 - iec-60320-c18 - iec-60320-c20 - iec-60320-c22 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15p - nema-5-15p - nema-5-20p - nema-5-30p - nema-5-50p - nema-6-15p - nema-6-20p - nema-6-30p - nema-6-50p - nema-10-30p - nema-10-50p - nema-14-20p - nema-14-30p - nema-14-50p - nema-14-60p - nema-15-15p - nema-15-20p - nema-15-30p - nema-15-50p - nema-15-60p - nema-l1-15p - nema-l5-15p - nema-l5-20p - nema-l5-30p - nema-l5-50p - nema-l6-15p - nema-l6-20p - nema-l6-30p - nema-l6-50p - nema-l10-30p - nema-l14-20p - nema-l14-30p - nema-l14-50p - nema-l14-60p - nema-l15-20p - nema-l15-30p - nema-l15-50p - nema-l15-60p - nema-l21-20p - nema-l21-30p - nema-l22-20p - nema-l22-30p - cs6361c - cs6365c - cs8165c - cs8265c - cs8365c - cs8465c - ita-c - ita-e - ita-f - ita-ef - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - usb-3-b - usb-3-micro-b - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - saf-d-grid - neutrik-powercon-20 - neutrik-powercon-32 - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c6` - C6 * `iec-60320-c8` - C8 * `iec-60320-c14` - C14 * `iec-60320-c16` - C16 * `iec-60320-c18` - C18 * `iec-60320-c20` - C20 * `iec-60320-c22` - C22 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15p` - NEMA 1-15P * `nema-5-15p` - NEMA 5-15P * `nema-5-20p` - NEMA 5-20P * `nema-5-30p` - NEMA 5-30P * `nema-5-50p` - NEMA 5-50P * `nema-6-15p` - NEMA 6-15P * `nema-6-20p` - NEMA 6-20P * `nema-6-30p` - NEMA 6-30P * `nema-6-50p` - NEMA 6-50P * `nema-10-30p` - NEMA 10-30P * `nema-10-50p` - NEMA 10-50P * `nema-14-20p` - NEMA 14-20P * `nema-14-30p` - NEMA 14-30P * `nema-14-50p` - NEMA 14-50P * `nema-14-60p` - NEMA 14-60P * `nema-15-15p` - NEMA 15-15P * `nema-15-20p` - NEMA 15-20P * `nema-15-30p` - NEMA 15-30P * `nema-15-50p` - NEMA 15-50P * `nema-15-60p` - NEMA 15-60P * `nema-l1-15p` - NEMA L1-15P * `nema-l5-15p` - NEMA L5-15P * `nema-l5-20p` - NEMA L5-20P * `nema-l5-30p` - NEMA L5-30P * `nema-l5-50p` - NEMA L5-50P * `nema-l6-15p` - NEMA L6-15P * `nema-l6-20p` - NEMA L6-20P * `nema-l6-30p` - NEMA L6-30P * `nema-l6-50p` - NEMA L6-50P * `nema-l10-30p` - NEMA L10-30P * `nema-l14-20p` - NEMA L14-20P * `nema-l14-30p` - NEMA L14-30P * `nema-l14-50p` - NEMA L14-50P * `nema-l14-60p` - NEMA L14-60P * `nema-l15-20p` - NEMA L15-20P * `nema-l15-30p` - NEMA L15-30P * `nema-l15-50p` - NEMA L15-50P * `nema-l15-60p` - NEMA L15-60P * `nema-l21-20p` - NEMA L21-20P * `nema-l21-30p` - NEMA L21-30P * `nema-l22-20p` - NEMA L22-20P * `nema-l22-30p` - NEMA L22-30P * `cs6361c` - CS6361C * `cs6365c` - CS6365C * `cs8165c` - CS8165C * `cs8265c` - CS8265C * `cs8365c` - CS8365C * `cs8465c` - CS8465C * `ita-c` - ITA Type C (CEE 7/16) * `ita-e` - ITA Type E (CEE 7/6) * `ita-f` - ITA Type F (CEE 7/4) * `ita-ef` - ITA Type E/F (CEE 7/7) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `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 * `usb-3-b` - USB 3.0 Type B * `usb-3-micro-b` - USB 3.0 Micro B * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20` - Neutrik powerCON (20A) * `neutrik-powercon-32` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: aadcbe6ca854c1ed label: type: string enum: - C6 - C8 - C14 - C16 - C18 - C20 - C22 - P+N+E 4H - P+N+E 6H - P+N+E 9H - 2P+E 4H - 2P+E 6H - 2P+E 9H - 3P+E 4H - 3P+E 6H - 3P+E 9H - 3P+N+E 4H - 3P+N+E 6H - 3P+N+E 9H - IEC 60906-1 - 2P+T 10A (NBR 14136) - 2P+T 20A (NBR 14136) - NEMA 1-15P - NEMA 5-15P - NEMA 5-20P - NEMA 5-30P - NEMA 5-50P - NEMA 6-15P - NEMA 6-20P - NEMA 6-30P - NEMA 6-50P - NEMA 10-30P - NEMA 10-50P - NEMA 14-20P - NEMA 14-30P - NEMA 14-50P - NEMA 14-60P - NEMA 15-15P - NEMA 15-20P - NEMA 15-30P - NEMA 15-50P - NEMA 15-60P - NEMA L1-15P - NEMA L5-15P - NEMA L5-20P - NEMA L5-30P - NEMA L5-50P - NEMA L6-15P - NEMA L6-20P - NEMA L6-30P - NEMA L6-50P - NEMA L10-30P - NEMA L14-20P - NEMA L14-30P - NEMA L14-50P - NEMA L14-60P - NEMA L15-20P - NEMA L15-30P - NEMA L15-50P - NEMA L15-60P - NEMA L21-20P - NEMA L21-30P - NEMA L22-20P - NEMA L22-30P - CS6361C - CS6365C - CS8165C - CS8265C - CS8365C - CS8465C - ITA Type C (CEE 7/16) - ITA Type E (CEE 7/6) - ITA Type F (CEE 7/4) - ITA Type E/F (CEE 7/7) - ITA Type G (BS 1363) - ITA Type H - ITA Type I - ITA Type J - ITA Type K - ITA Type L (CEI 23-50) - ITA Type M (BS 546) - ITA Type N - ITA Type O - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB Micro AB - USB 3.0 Type B - USB 3.0 Micro B - Molex Micro-Fit 1x2 - Molex Micro-Fit 2x2 - Molex Micro-Fit 2x3 - Molex Micro-Fit 2x4 - DC Terminal - Saf-D-Grid - Neutrik powerCON (20A) - Neutrik powerCON (32A) - Neutrik powerCON TRUE1 - Neutrik powerCON TRUE1 TOP - Ubiquiti SmartPower - Hardwired - Other nullable: true maximum_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Maximum power draw (watts) allocated_draw: type: integer maximum: 2147483647 minimum: 1 nullable: true description: Allocated power draw (watts) description: type: string maxLength: 200 created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - id - last_updated - name - url PaginatedModuleList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Module' WritableConsoleServerPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - mini-din-8 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other - '' - null type: string 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' x-spec-enum-id: 7b8d0e83a4bb5178 nullable: true description: type: string maxLength: 200 required: - name WritableRearPortTemplateRequest: type: object 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)' properties: device_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceTypeRequest' nullable: true nullable: true module_type: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleTypeRequest' nullable: true nullable: true name: type: string minLength: 1 description: '{module} is accepted as a substitution for the module bay position when attached to a module type.' maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 front_ports: type: array items: $ref: '#/components/schemas/RearPortTemplateMappingRequest' description: type: string maxLength: 200 required: - name - type PatchedWritableVirtualDeviceContextRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 64 device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' identifier: type: integer maximum: 32767 minimum: 0 nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true primary_ip4: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true primary_ip6: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true status: enum: - active - planned - offline type: string description: '* `active` - Active * `planned` - Planned * `offline` - Offline' x-spec-enum-id: 0e2c0919d51b83cb description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} WritableFrontPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 rear_ports: type: array items: $ref: '#/components/schemas/FrontPortMappingRequest' description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name - type PatchedPowerPanelRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: site: oneOf: - type: integer - $ref: '#/components/schemas/BriefSiteRequest' location: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefLocationRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedPowerPanelList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/PowerPanel' BriefTenantRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug Location: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ site: $ref: '#/components/schemas/BriefSite' parent: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true status: type: object properties: value: enum: - planned - staging - active - decommissioning - retired type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `retired` - Retired' x-spec-enum-id: 1cf60831fbb35e7f label: type: string enum: - Planned - Staging - Active - Decommissioning - Retired tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true facility: type: string description: Local facility ID or description maxLength: 50 description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true rack_count: type: integer readOnly: true default: 0 device_count: type: integer readOnly: true default: 0 prefix_count: type: integer format: int64 readOnly: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string _depth: type: integer readOnly: true title: ' depth' required: - _depth - created - device_count - display - display_url - id - last_updated - name - prefix_count - rack_count - site - slug - url FrontPortTemplateMapping: type: object properties: position: type: integer rear_port: type: integer rear_port_position: type: integer maximum: 1024 minimum: 1 default: 1 required: - position - rear_port PaginatedDeviceBayTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/DeviceBayTemplate' BriefLocation: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 rack_count: type: integer readOnly: true default: 0 _depth: type: integer readOnly: true title: ' depth' required: - _depth - display - id - name - rack_count - slug - url WritableRearPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 front_ports: type: array items: $ref: '#/components/schemas/RearPortMappingRequest' description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - device - name - type PaginatedPowerOutletTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/PowerOutletTemplate' PaginatedInterfaceList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Interface' BriefDeviceRoleRequest: type: object description: Base serializer class for models inheriting from NestedGroupModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug BriefVRF: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 rd: type: string nullable: true title: Route distinguisher description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 description: type: string maxLength: 200 prefix_count: type: integer format: int64 readOnly: true required: - display - id - name - prefix_count - url GenericObject: type: object description: Minimal representation of some generic object identified by ContentType and PK. properties: object_type: type: string object_id: type: integer object: nullable: true readOnly: true required: - object - object_id - object_type PatchedWritableFrontPortRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' module: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefModuleRequest' nullable: true nullable: true name: type: string minLength: 1 maxLength: 64 label: type: string description: Physical label maxLength: 64 type: enum: - 8p8c - 8p6c - 8p4c - 8p2c - 6p6c - 6p4c - 6p2c - 4p4c - 4p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - f - n - mrj21 - fc - fc-pc - fc-upc - fc-apc - lc - lc-pc - lc-upc - lc-apc - lsh - lsh-pc - lsh-upc - lsh-apc - lx5 - lx5-pc - lx5-upc - lx5-apc - mpo - mtrj - sc - sc-pc - sc-upc - sc-apc - st - cs - sn - sma-905 - sma-906 - urm-p2 - urm-p4 - urm-p8 - splice - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-micro-ab - other type: string description: '* `8p8c` - 8P8C * `8p6c` - 8P6C * `8p4c` - 8P4C * `8p2c` - 8P2C * `6p6c` - 6P6C * `6p4c` - 6P4C * `6p2c` - 6P2C * `4p4c` - 4P4C * `4p2c` - 4P2C * `gg45` - GG45 * `tera-4p` - TERA 4P * `tera-2p` - TERA 2P * `tera-1p` - TERA 1P * `110-punch` - 110 Punch * `bnc` - BNC * `f` - F Connector * `n` - N Connector * `mrj21` - MRJ21 * `fc` - FC * `fc-pc` - FC/PC * `fc-upc` - FC/UPC * `fc-apc` - FC/APC * `lc` - LC * `lc-pc` - LC/PC * `lc-upc` - LC/UPC * `lc-apc` - LC/APC * `lsh` - LSH * `lsh-pc` - LSH/PC * `lsh-upc` - LSH/UPC * `lsh-apc` - LSH/APC * `lx5` - LX.5 * `lx5-pc` - LX.5/PC * `lx5-upc` - LX.5/UPC * `lx5-apc` - LX.5/APC * `mpo` - MPO * `mtrj` - MTRJ * `sc` - SC * `sc-pc` - SC/PC * `sc-upc` - SC/UPC * `sc-apc` - SC/APC * `st` - ST * `cs` - CS * `sn` - SN * `sma-905` - SMA 905 * `sma-906` - SMA 906 * `urm-p2` - URM-P2 * `urm-p4` - URM-P4 * `urm-p8` - URM-P8 * `splice` - Splice * `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' x-spec-enum-id: 2696b7065f33307c color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 positions: type: integer maximum: 1024 minimum: 1 rear_ports: type: array items: $ref: '#/components/schemas/FrontPortMappingRequest' description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} Module: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' module_bay: $ref: '#/components/schemas/NestedModuleBay' module_type: $ref: '#/components/schemas/BriefModuleType' status: type: object properties: value: enum: - offline - active - planned - staged - failed - decommissioning type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning' x-spec-enum-id: 545817eb4c4f2ae4 label: type: string enum: - Offline - Active - Planned - Staged - Failed - Decommissioning serial: type: string title: Serial number maxLength: 50 asset_tag: type: string nullable: true description: A unique tag used to identify this device maxLength: 50 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - device - display - display_url - id - last_updated - module_bay - module_type - url PaginatedModuleTypeList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ModuleType' PaginatedRackList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Rack' NestedTagRequest: type: object 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.' properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 pattern: ^[-\w]+$ maxLength: 100 color: type: string minLength: 1 pattern: ^[0-9a-f]{6}$ maxLength: 6 required: - name - slug PowerOutlet: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' module: allOf: - $ref: '#/components/schemas/BriefModule' nullable: true name: type: string maxLength: 64 label: type: string description: Physical label maxLength: 64 type: type: object properties: value: enum: - iec-60320-c5 - iec-60320-c7 - iec-60320-c13 - iec-60320-c15 - iec-60320-c17 - iec-60320-c19 - iec-60320-c21 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - iec-60906-1 - nbr-14136-10a - nbr-14136-20a - nema-1-15r - nema-5-15r - nema-5-20r - nema-5-30r - nema-5-50r - nema-6-15r - nema-6-20r - nema-6-30r - nema-6-50r - nema-10-30r - nema-10-50r - nema-14-20r - nema-14-30r - nema-14-50r - nema-14-60r - nema-15-15r - nema-15-20r - nema-15-30r - nema-15-50r - nema-15-60r - nema-l1-15r - nema-l5-15r - nema-l5-20r - nema-l5-30r - nema-l5-50r - nema-l6-15r - nema-l6-20r - nema-l6-30r - nema-l6-50r - nema-l10-30r - nema-l14-20r - nema-l14-30r - nema-l14-50r - nema-l14-60r - nema-l15-20r - nema-l15-30r - nema-l15-50r - nema-l15-60r - nema-l21-20r - nema-l21-30r - nema-l22-20r - nema-l22-30r - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ita-e - ita-f - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - ita-multistandard - usb-a - usb-micro-b - usb-c - molex-micro-fit-1x2 - molex-micro-fit-2x2 - molex-micro-fit-2x3 - molex-micro-fit-2x4 - dc-terminal - eaton-c39 - hdot-cx - saf-d-grid - neutrik-powercon-20a - neutrik-powercon-32a - neutrik-powercon-true1 - neutrik-powercon-true1-top - ubiquiti-smartpower - hardwired - other - '' - null type: string description: '* `iec-60320-c5` - C5 * `iec-60320-c7` - C7 * `iec-60320-c13` - C13 * `iec-60320-c15` - C15 * `iec-60320-c17` - C17 * `iec-60320-c19` - C19 * `iec-60320-c21` - C21 * `iec-60309-p-n-e-4h` - P+N+E 4H * `iec-60309-p-n-e-6h` - P+N+E 6H * `iec-60309-p-n-e-9h` - P+N+E 9H * `iec-60309-2p-e-4h` - 2P+E 4H * `iec-60309-2p-e-6h` - 2P+E 6H * `iec-60309-2p-e-9h` - 2P+E 9H * `iec-60309-3p-e-4h` - 3P+E 4H * `iec-60309-3p-e-6h` - 3P+E 6H * `iec-60309-3p-e-9h` - 3P+E 9H * `iec-60309-3p-n-e-4h` - 3P+N+E 4H * `iec-60309-3p-n-e-6h` - 3P+N+E 6H * `iec-60309-3p-n-e-9h` - 3P+N+E 9H * `iec-60906-1` - IEC 60906-1 * `nbr-14136-10a` - 2P+T 10A (NBR 14136) * `nbr-14136-20a` - 2P+T 20A (NBR 14136) * `nema-1-15r` - NEMA 1-15R * `nema-5-15r` - NEMA 5-15R * `nema-5-20r` - NEMA 5-20R * `nema-5-30r` - NEMA 5-30R * `nema-5-50r` - NEMA 5-50R * `nema-6-15r` - NEMA 6-15R * `nema-6-20r` - NEMA 6-20R * `nema-6-30r` - NEMA 6-30R * `nema-6-50r` - NEMA 6-50R * `nema-10-30r` - NEMA 10-30R * `nema-10-50r` - NEMA 10-50R * `nema-14-20r` - NEMA 14-20R * `nema-14-30r` - NEMA 14-30R * `nema-14-50r` - NEMA 14-50R * `nema-14-60r` - NEMA 14-60R * `nema-15-15r` - NEMA 15-15R * `nema-15-20r` - NEMA 15-20R * `nema-15-30r` - NEMA 15-30R * `nema-15-50r` - NEMA 15-50R * `nema-15-60r` - NEMA 15-60R * `nema-l1-15r` - NEMA L1-15R * `nema-l5-15r` - NEMA L5-15R * `nema-l5-20r` - NEMA L5-20R * `nema-l5-30r` - NEMA L5-30R * `nema-l5-50r` - NEMA L5-50R * `nema-l6-15r` - NEMA L6-15R * `nema-l6-20r` - NEMA L6-20R * `nema-l6-30r` - NEMA L6-30R * `nema-l6-50r` - NEMA L6-50R * `nema-l10-30r` - NEMA L10-30R * `nema-l14-20r` - NEMA L14-20R * `nema-l14-30r` - NEMA L14-30R * `nema-l14-50r` - NEMA L14-50R * `nema-l14-60r` - NEMA L14-60R * `nema-l15-20r` - NEMA L15-20R * `nema-l15-30r` - NEMA L15-30R * `nema-l15-50r` - NEMA L15-50R * `nema-l15-60r` - NEMA L15-60R * `nema-l21-20r` - NEMA L21-20R * `nema-l21-30r` - NEMA L21-30R * `nema-l22-20r` - NEMA L22-20R * `nema-l22-30r` - NEMA L22-30R * `CS6360C` - CS6360C * `CS6364C` - CS6364C * `CS8164C` - CS8164C * `CS8264C` - CS8264C * `CS8364C` - CS8364C * `CS8464C` - CS8464C * `ita-e` - ITA Type E (CEE 7/5) * `ita-f` - ITA Type F (CEE 7/3) * `ita-g` - ITA Type G (BS 1363) * `ita-h` - ITA Type H * `ita-i` - ITA Type I * `ita-j` - ITA Type J * `ita-k` - ITA Type K * `ita-l` - ITA Type L (CEI 23-50) * `ita-m` - ITA Type M (BS 546) * `ita-n` - ITA Type N * `ita-o` - ITA Type O * `ita-multistandard` - ITA Multistandard * `usb-a` - USB Type A * `usb-micro-b` - USB Micro B * `usb-c` - USB Type C * `molex-micro-fit-1x2` - Molex Micro-Fit 1x2 * `molex-micro-fit-2x2` - Molex Micro-Fit 2x2 * `molex-micro-fit-2x3` - Molex Micro-Fit 2x3 * `molex-micro-fit-2x4` - Molex Micro-Fit 2x4 * `dc-terminal` - DC Terminal * `eaton-c39` - Eaton C39 * `hdot-cx` - HDOT Cx * `saf-d-grid` - Saf-D-Grid * `neutrik-powercon-20a` - Neutrik powerCON (20A) * `neutrik-powercon-32a` - Neutrik powerCON (32A) * `neutrik-powercon-true1` - Neutrik powerCON TRUE1 * `neutrik-powercon-true1-top` - Neutrik powerCON TRUE1 TOP * `ubiquiti-smartpower` - Ubiquiti SmartPower * `hardwired` - Hardwired * `other` - Other' x-spec-enum-id: db3e4eb2b93615f8 label: type: string enum: - C5 - C7 - C13 - C15 - C17 - C19 - C21 - P+N+E 4H - P+N+E 6H - P+N+E 9H - 2P+E 4H - 2P+E 6H - 2P+E 9H - 3P+E 4H - 3P+E 6H - 3P+E 9H - 3P+N+E 4H - 3P+N+E 6H - 3P+N+E 9H - IEC 60906-1 - 2P+T 10A (NBR 14136) - 2P+T 20A (NBR 14136) - NEMA 1-15R - NEMA 5-15R - NEMA 5-20R - NEMA 5-30R - NEMA 5-50R - NEMA 6-15R - NEMA 6-20R - NEMA 6-30R - NEMA 6-50R - NEMA 10-30R - NEMA 10-50R - NEMA 14-20R - NEMA 14-30R - NEMA 14-50R - NEMA 14-60R - NEMA 15-15R - NEMA 15-20R - NEMA 15-30R - NEMA 15-50R - NEMA 15-60R - NEMA L1-15R - NEMA L5-15R - NEMA L5-20R - NEMA L5-30R - NEMA L5-50R - NEMA L6-15R - NEMA L6-20R - NEMA L6-30R - NEMA L6-50R - NEMA L10-30R - NEMA L14-20R - NEMA L14-30R - NEMA L14-50R - NEMA L14-60R - NEMA L15-20R - NEMA L15-30R - NEMA L15-50R - NEMA L15-60R - NEMA L21-20R - NEMA L21-30R - NEMA L22-20R - NEMA L22-30R - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ITA Type E (CEE 7/5) - ITA Type F (CEE 7/3) - ITA Type G (BS 1363) - ITA Type H - ITA Type I - ITA Type J - ITA Type K - ITA Type L (CEI 23-50) - ITA Type M (BS 546) - ITA Type N - ITA Type O - ITA Multistandard - USB Type A - USB Micro B - USB Type C - Molex Micro-Fit 1x2 - Molex Micro-Fit 2x2 - Molex Micro-Fit 2x3 - Molex Micro-Fit 2x4 - DC Terminal - Eaton C39 - HDOT Cx - Saf-D-Grid - Neutrik powerCON (20A) - Neutrik powerCON (32A) - Neutrik powerCON TRUE1 - Neutrik powerCON TRUE1 TOP - Ubiquiti SmartPower - Hardwired - Other nullable: true status: type: object properties: value: enum: - enabled - disabled - faulty type: string description: '* `enabled` - Enabled * `disabled` - Disabled * `faulty` - Faulty' x-spec-enum-id: d60dce16858f3c69 label: type: string enum: - Enabled - Disabled - Faulty color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 power_port: allOf: - $ref: '#/components/schemas/BriefPowerPort' nullable: true feed_leg: type: object properties: value: enum: - A - B - C - '' - null type: string description: '* `A` - A * `B` - B * `C` - C' x-spec-enum-id: a4902339df0b7c06 label: type: string enum: - A - B - C nullable: true description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected cable: allOf: - $ref: '#/components/schemas/BriefCable' readOnly: true nullable: true cable_end: type: string readOnly: true link_peers: type: array items: {} readOnly: true link_peers_type: type: string description: Return the type of the peer link terminations, or None. readOnly: true nullable: true connected_endpoints: type: array items: {} nullable: true readOnly: true connected_endpoints_type: type: string readOnly: true nullable: true connected_endpoints_reachable: type: boolean readOnly: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - cable - cable_end - connected_endpoints - connected_endpoints_reachable - connected_endpoints_type - created - device - display - display_url - id - last_updated - link_peers - link_peers_type - name - url securitySchemes: cookieAuth: type: apiKey in: cookie name: sessionid tokenAuth: type: apiKey in: header name: Authorization description: '`Token ` (v1) or `Bearer .` (v2)'