openapi: 3.0.3 info: title: NetBox REST authentication-check virtualization API version: 4.5.9 (4.5) license: name: Apache v2 License servers: - url: '' description: NetBox tags: - name: virtualization paths: /api/virtualization/cluster-groups/: get: operationId: virtualization_cluster_groups_list description: Get a list of cluster group 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: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedClusterGroupList' description: '' post: operationId: virtualization_cluster_groups_create description: Post a list of cluster group objects. tags: - virtualization requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ClusterGroupRequest' - type: array items: $ref: '#/components/schemas/ClusterGroupRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/ClusterGroupRequest' - type: array items: $ref: '#/components/schemas/ClusterGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ClusterGroup' description: '' put: operationId: virtualization_cluster_groups_bulk_update description: Put a list of cluster group objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ClusterGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterGroup' description: '' patch: operationId: virtualization_cluster_groups_bulk_partial_update description: Patch a list of cluster group objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ClusterGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterGroup' description: '' delete: operationId: virtualization_cluster_groups_bulk_destroy description: Delete a list of cluster group objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ClusterGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/cluster-groups/{id}/: get: operationId: virtualization_cluster_groups_retrieve description: Get a cluster group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster group. required: true tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClusterGroup' description: '' put: operationId: virtualization_cluster_groups_update description: Put a cluster group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster group. required: true tags: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/ClusterGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/ClusterGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClusterGroup' description: '' patch: operationId: virtualization_cluster_groups_partial_update description: Patch a cluster group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster group. required: true tags: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedClusterGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedClusterGroupRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClusterGroup' description: '' delete: operationId: virtualization_cluster_groups_destroy description: Delete a cluster group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster group. required: true tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/cluster-types/: get: operationId: virtualization_cluster_types_list description: Get a list of cluster 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: 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: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedClusterTypeList' description: '' post: operationId: virtualization_cluster_types_create description: Post a list of cluster type objects. tags: - virtualization requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ClusterTypeRequest' - type: array items: $ref: '#/components/schemas/ClusterTypeRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/ClusterTypeRequest' - type: array items: $ref: '#/components/schemas/ClusterTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ClusterType' description: '' put: operationId: virtualization_cluster_types_bulk_update description: Put a list of cluster type objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ClusterTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterType' description: '' patch: operationId: virtualization_cluster_types_bulk_partial_update description: Patch a list of cluster type objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ClusterTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterType' description: '' delete: operationId: virtualization_cluster_types_bulk_destroy description: Delete a list of cluster type objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ClusterTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/cluster-types/{id}/: get: operationId: virtualization_cluster_types_retrieve description: Get a cluster type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster type. required: true tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClusterType' description: '' put: operationId: virtualization_cluster_types_update description: Put a cluster type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster type. required: true tags: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/ClusterTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/ClusterTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClusterType' description: '' patch: operationId: virtualization_cluster_types_partial_update description: Patch a cluster type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster type. required: true tags: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedClusterTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedClusterTypeRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClusterType' description: '' delete: operationId: virtualization_cluster_types_destroy description: Delete a cluster type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster type. required: true tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/clusters/: get: operationId: virtualization_clusters_list description: Get a list of cluster 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: group schema: type: array items: type: string description: Parent group (slug) explode: true style: form - in: query name: group__n schema: type: array items: type: string description: Parent group (slug) explode: true style: form - in: query name: group_id schema: type: array items: type: integer nullable: true description: Parent group (ID) explode: true style: form - in: query name: group_id__n schema: type: array items: type: integer nullable: true description: Parent group (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 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 - 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: scope_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__empty schema: type: boolean - in: query name: scope_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_type schema: type: array items: type: string explode: true style: form - in: query name: scope_type__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: 65a25166053759eb 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: 65a25166053759eb explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 65a25166053759eb explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 65a25166053759eb explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 65a25166053759eb explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 65a25166053759eb explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 65a25166053759eb explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 65a25166053759eb explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 65a25166053759eb explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 65a25166053759eb explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 65a25166053759eb explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 65a25166053759eb 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: array items: type: string description: Cluster type (slug) explode: true style: form - in: query name: type__n schema: type: array items: type: string description: Cluster type (slug) explode: true style: form - in: query name: type_id schema: type: array items: type: integer description: Cluster type (ID) explode: true style: form - in: query name: type_id__n schema: type: array items: type: integer description: Cluster type (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedClusterList' description: '' post: operationId: virtualization_clusters_create description: Post a list of cluster objects. tags: - virtualization requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableClusterRequest' - type: array items: $ref: '#/components/schemas/WritableClusterRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableClusterRequest' - type: array items: $ref: '#/components/schemas/WritableClusterRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Cluster' description: '' put: operationId: virtualization_clusters_bulk_update description: Put a list of cluster objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ClusterRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Cluster' description: '' patch: operationId: virtualization_clusters_bulk_partial_update description: Patch a list of cluster objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ClusterRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Cluster' description: '' delete: operationId: virtualization_clusters_bulk_destroy description: Delete a list of cluster objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ClusterRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ClusterRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/clusters/{id}/: get: operationId: virtualization_clusters_retrieve description: Get a cluster object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster. required: true tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Cluster' description: '' put: operationId: virtualization_clusters_update description: Put a cluster object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster. required: true tags: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableClusterRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableClusterRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Cluster' description: '' patch: operationId: virtualization_clusters_partial_update description: Patch a cluster object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster. required: true tags: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableClusterRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableClusterRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Cluster' description: '' delete: operationId: virtualization_clusters_destroy description: Delete a cluster object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this cluster. required: true tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/interfaces/: get: operationId: virtualization_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: cluster schema: type: array items: type: string description: Cluster explode: true style: form - in: query name: cluster__n schema: type: array items: type: string description: Cluster explode: true style: form - in: query name: cluster_id schema: type: array items: type: integer description: Cluster (ID) explode: true style: form - in: query name: cluster_id__n schema: type: array items: type: integer description: Cluster (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: 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: 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: 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: 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: 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 - 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: 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: 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 description: Virtual machine explode: true style: form - in: query name: virtual_machine__n schema: type: array items: type: string description: Virtual machine explode: true style: form - in: query name: virtual_machine_id schema: type: array items: type: integer description: Virtual machine (ID) explode: true style: form - in: query name: virtual_machine_id__n schema: type: array items: type: integer description: Virtual machine (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 tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVMInterfaceList' description: '' post: operationId: virtualization_interfaces_create description: Post a list of interface objects. tags: - virtualization requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableVMInterfaceRequest' - type: array items: $ref: '#/components/schemas/WritableVMInterfaceRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableVMInterfaceRequest' - type: array items: $ref: '#/components/schemas/WritableVMInterfaceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VMInterface' description: '' put: operationId: virtualization_interfaces_bulk_update description: Put a list of interface objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VMInterfaceRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VMInterfaceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VMInterface' description: '' patch: operationId: virtualization_interfaces_bulk_partial_update description: Patch a list of interface objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VMInterfaceRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VMInterfaceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VMInterface' description: '' delete: operationId: virtualization_interfaces_bulk_destroy description: Delete a list of interface objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VMInterfaceRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VMInterfaceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/interfaces/{id}/: get: operationId: virtualization_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: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VMInterface' description: '' put: operationId: virtualization_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: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVMInterfaceRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableVMInterfaceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VMInterface' description: '' patch: operationId: virtualization_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: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVMInterfaceRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableVMInterfaceRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VMInterface' description: '' delete: operationId: virtualization_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: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/virtual-disks/: get: operationId: virtualization_virtual_disks_list description: Get a list of virtual disk 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: size schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: size__empty schema: type: boolean - in: query name: size__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: size__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: size__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: size__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: size__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: updated_by_request schema: type: string format: uuid - in: query name: virtual_machine schema: type: array items: type: string description: Virtual machine explode: true style: form - in: query name: virtual_machine__n schema: type: array items: type: string description: Virtual machine explode: true style: form - in: query name: virtual_machine_id schema: type: array items: type: integer description: Virtual machine (ID) explode: true style: form - in: query name: virtual_machine_id__n schema: type: array items: type: integer description: Virtual machine (ID) explode: true style: form tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVirtualDiskList' description: '' post: operationId: virtualization_virtual_disks_create description: Post a list of virtual disk objects. tags: - virtualization requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/VirtualDiskRequest' - type: array items: $ref: '#/components/schemas/VirtualDiskRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/VirtualDiskRequest' - type: array items: $ref: '#/components/schemas/VirtualDiskRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VirtualDisk' description: '' put: operationId: virtualization_virtual_disks_bulk_update description: Put a list of virtual disk objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualDiskRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualDiskRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualDisk' description: '' patch: operationId: virtualization_virtual_disks_bulk_partial_update description: Patch a list of virtual disk objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualDiskRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualDiskRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualDisk' description: '' delete: operationId: virtualization_virtual_disks_bulk_destroy description: Delete a list of virtual disk objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualDiskRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualDiskRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/virtual-disks/{id}/: get: operationId: virtualization_virtual_disks_retrieve description: Get a virtual disk object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual disk. required: true tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualDisk' description: '' put: operationId: virtualization_virtual_disks_update description: Put a virtual disk object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual disk. required: true tags: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/VirtualDiskRequest' multipart/form-data: schema: $ref: '#/components/schemas/VirtualDiskRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualDisk' description: '' patch: operationId: virtualization_virtual_disks_partial_update description: Patch a virtual disk object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual disk. required: true tags: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedVirtualDiskRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedVirtualDiskRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualDisk' description: '' delete: operationId: virtualization_virtual_disks_destroy description: Delete a virtual disk object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual disk. required: true tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/virtual-machines/: get: operationId: virtualization_virtual_machines_list description: Get a list of virtual machine objects. parameters: - in: query name: cluster schema: type: array items: type: string description: Cluster explode: true style: form - in: query name: cluster__n schema: type: array items: type: string description: Cluster 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: Cluster (ID) explode: true style: form - in: query name: cluster_id__n schema: type: array items: type: integer nullable: true description: Cluster (ID) explode: true style: form - in: query name: cluster_type schema: type: array items: type: string description: Cluster type (slug) explode: true style: form - in: query name: cluster_type__n schema: type: array items: type: string description: Cluster type (slug) explode: true style: form - in: query name: cluster_type_id schema: type: array items: type: integer description: Cluster type (ID) explode: true style: form - in: query name: cluster_type_id__n schema: type: array items: type: integer description: Cluster type (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: 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 schema: type: array items: type: string nullable: true description: Device explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device explode: true style: form - in: query name: device_id schema: type: array items: type: integer nullable: true description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer nullable: true description: Device (ID) explode: true style: form - in: query name: disk schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: disk__empty schema: type: boolean - in: query name: disk__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: disk__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: disk__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: disk__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: disk__n schema: type: array items: type: integer format: int32 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: 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: 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: local_context_data schema: type: boolean description: Has local config context data - 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: memory schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: memory__empty schema: type: boolean - in: query name: memory__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: memory__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: memory__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: memory__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: memory__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: 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: 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: 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 (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 nullable: true description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer nullable: true description: Site (ID) explode: true style: form - in: query name: start_on_boot schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: start_on_boot__empty schema: type: boolean - in: query name: start_on_boot__ic schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: start_on_boot__ie schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: start_on_boot__iew schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: start_on_boot__iregex schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: start_on_boot__isw schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: start_on_boot__n schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: start_on_boot__nic schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: start_on_boot__nie schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: start_on_boot__niew schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: start_on_boot__nisw schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: start_on_boot__regex schema: type: array items: type: string x-spec-enum-id: 610e33fc2fde73d6 explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: effecc3b94e0b74b 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: effecc3b94e0b74b explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: effecc3b94e0b74b explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: effecc3b94e0b74b explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: effecc3b94e0b74b explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: effecc3b94e0b74b explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: effecc3b94e0b74b explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: effecc3b94e0b74b explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: effecc3b94e0b74b explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: effecc3b94e0b74b explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: effecc3b94e0b74b explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: effecc3b94e0b74b 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: vcpus schema: type: array items: type: number format: double explode: true style: form - in: query name: vcpus__empty schema: type: boolean - in: query name: vcpus__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: vcpus__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: vcpus__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: vcpus__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: vcpus__n schema: type: array items: type: number format: double explode: true style: form - in: query name: virtual_disk_count schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: virtual_disk_count__empty schema: type: boolean - in: query name: virtual_disk_count__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: virtual_disk_count__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: virtual_disk_count__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: virtual_disk_count__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: virtual_disk_count__n schema: type: array items: type: integer format: int32 explode: true style: form tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVirtualMachineWithConfigContextList' description: '' post: operationId: virtualization_virtual_machines_create description: Post a list of virtual machine objects. tags: - virtualization requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' - type: array items: $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' - type: array items: $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VirtualMachineWithConfigContext' description: '' put: operationId: virtualization_virtual_machines_bulk_update description: Put a list of virtual machine objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualMachineWithConfigContext' description: '' patch: operationId: virtualization_virtual_machines_bulk_partial_update description: Patch a list of virtual machine objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualMachineWithConfigContext' description: '' delete: operationId: virtualization_virtual_machines_bulk_destroy description: Delete a list of virtual machine objects. tags: - virtualization requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualMachineWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/virtual-machines/{id}/: get: operationId: virtualization_virtual_machines_retrieve description: Get a virtual machine object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual machine. required: true tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualMachineWithConfigContext' description: '' put: operationId: virtualization_virtual_machines_update description: Put a virtual machine object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual machine. required: true tags: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualMachineWithConfigContext' description: '' patch: operationId: virtualization_virtual_machines_partial_update description: Patch a virtual machine object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual machine. required: true tags: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContextRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContextRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualMachineWithConfigContext' description: '' delete: operationId: virtualization_virtual_machines_destroy description: Delete a virtual machine object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual machine. required: true tags: - virtualization security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/virtualization/virtual-machines/{id}/render-config/: post: operationId: virtualization_virtual_machines_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 virtual machine. required: true tags: - virtualization requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualMachineWithConfigContext' text/plain: schema: $ref: '#/components/schemas/VirtualMachineWithConfigContext' description: '' components: schemas: ClusterType: 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 cluster_count: type: integer format: int64 readOnly: true required: - cluster_count - created - display - display_url - id - last_updated - name - slug - url 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 ClusterGroup: 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 cluster_count: type: integer format: int64 readOnly: true required: - cluster_count - created - display - display_url - id - last_updated - name - slug - url NestedVirtualMachine: 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 BriefClusterTypeRequest: 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 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 NestedVMInterface: 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 virtual_machine: allOf: - $ref: '#/components/schemas/NestedVirtualMachine' readOnly: true name: type: string maxLength: 64 required: - display - display_url - id - name - url - virtual_machine 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 Cluster: 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 type: $ref: '#/components/schemas/BriefClusterType' group: allOf: - $ref: '#/components/schemas/BriefClusterGroup' nullable: true status: type: object properties: value: enum: - planned - staging - active - decommissioning - offline type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `offline` - Offline' x-spec-enum-id: 65a25166053759eb label: type: string enum: - Planned - Staging - Active - Decommissioning - Offline tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true scope_type: type: string nullable: true scope_id: type: integer nullable: true scope: 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 device_count: type: integer format: int64 readOnly: true virtualmachine_count: type: integer format: int64 readOnly: true allocated_vcpus: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true readOnly: true allocated_memory: type: integer readOnly: true allocated_disk: type: integer readOnly: true required: - allocated_disk - allocated_memory - allocated_vcpus - created - device_count - display - display_url - id - last_updated - name - scope - type - url - virtualmachine_count PatchedWritableVMInterfaceRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: virtual_machine: oneOf: - type: integer - $ref: '#/components/schemas/BriefVirtualMachineRequest' name: type: string minLength: 1 maxLength: 64 enabled: type: boolean parent: type: integer nullable: true title: Parent interface bridge: type: integer nullable: true title: Bridge interface mtu: type: integer maximum: 65536 minimum: 1 nullable: true primary_mac_address: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefMACAddressRequest' nullable: true nullable: true 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)' 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 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: {} 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 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 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 PaginatedVirtualMachineWithConfigContextList: 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/VirtualMachineWithConfigContext' PaginatedClusterTypeList: 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/ClusterType' PaginatedVMInterfaceList: 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/VMInterface' 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 BriefClusterGroupRequest: 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 BriefClusterType: 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 cluster_count: type: integer format: int64 readOnly: true required: - cluster_count - display - id - name - slug - url 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 VirtualMachineWithConfigContextRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 64 status: enum: - offline - active - planned - staged - failed - decommissioning - paused type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning * `paused` - Paused' x-spec-enum-id: effecc3b94e0b74b start_on_boot: enum: - 'on' - 'off' - laststate type: string description: '* `on` - On * `off` - Off * `laststate` - Last State' x-spec-enum-id: 610e33fc2fde73d6 site: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefSiteRequest' nullable: true nullable: true cluster: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefClusterRequest' nullable: true nullable: true device: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceRequest' nullable: true nullable: true serial: type: string title: Serial number maxLength: 50 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceRoleRequest' nullable: true nullable: true 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 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 vcpus: type: number format: double maximum: 10000 minimum: 0.01 exclusiveMaximum: true nullable: true memory: type: integer maximum: 2147483647 minimum: 0 nullable: true disk: type: integer maximum: 2147483647 minimum: 0 nullable: true 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: - name ClusterGroupRequest: 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 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 PaginatedClusterGroupList: 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/ClusterGroup' 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 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 PatchedClusterTypeRequest: 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: {} PatchedClusterGroupRequest: 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: {} 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 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 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 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 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 WritableClusterRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 type: oneOf: - type: integer - $ref: '#/components/schemas/BriefClusterTypeRequest' group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefClusterGroupRequest' nullable: true nullable: true status: enum: - planned - staging - active - decommissioning - offline type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `offline` - Offline' x-spec-enum-id: 65a25166053759eb tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true scope_type: type: string nullable: true scope_id: 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 - type WritableVirtualMachineWithConfigContextRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 64 status: enum: - offline - active - planned - staged - failed - decommissioning - paused type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning * `paused` - Paused' x-spec-enum-id: effecc3b94e0b74b start_on_boot: enum: - 'on' - 'off' - laststate type: string description: '* `on` - On * `off` - Off * `laststate` - Last State' x-spec-enum-id: 610e33fc2fde73d6 site: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefSiteRequest' nullable: true nullable: true cluster: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefClusterRequest' nullable: true nullable: true device: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceRequest' nullable: true nullable: true serial: type: string title: Serial number maxLength: 50 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceRoleRequest' nullable: true nullable: true 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 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 vcpus: type: number format: double maximum: 10000 minimum: 0.01 exclusiveMaximum: true nullable: true memory: type: integer maximum: 2147483647 minimum: 0 nullable: true disk: type: integer maximum: 2147483647 minimum: 0 nullable: true 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: - name 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 BriefClusterGroup: 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 cluster_count: type: integer format: int64 readOnly: true required: - cluster_count - display - id - name - slug - url VirtualDisk: 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 virtual_machine: $ref: '#/components/schemas/BriefVirtualMachine' name: type: string maxLength: 64 description: type: string maxLength: 200 size: type: integer maximum: 2147483647 minimum: 0 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 - display - display_url - id - last_updated - name - size - url - virtual_machine PaginatedClusterList: 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/Cluster' 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 PatchedWritableVirtualMachineWithConfigContextRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 64 status: enum: - offline - active - planned - staged - failed - decommissioning - paused type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning * `paused` - Paused' x-spec-enum-id: effecc3b94e0b74b start_on_boot: enum: - 'on' - 'off' - laststate type: string description: '* `on` - On * `off` - Off * `laststate` - Last State' x-spec-enum-id: 610e33fc2fde73d6 site: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefSiteRequest' nullable: true nullable: true cluster: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefClusterRequest' nullable: true nullable: true device: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceRequest' nullable: true nullable: true serial: type: string title: Serial number maxLength: 50 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefDeviceRoleRequest' nullable: true nullable: true 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 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 vcpus: type: number format: double maximum: 10000 minimum: 0.01 exclusiveMaximum: true nullable: true memory: type: integer maximum: 2147483647 minimum: 0 nullable: true disk: type: integer maximum: 2147483647 minimum: 0 nullable: true 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: {} VirtualDiskRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: virtual_machine: oneOf: - type: integer - $ref: '#/components/schemas/BriefVirtualMachineRequest' name: type: string minLength: 1 maxLength: 64 description: type: string maxLength: 200 size: type: integer maximum: 2147483647 minimum: 0 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: - name - size - virtual_machine PatchedWritableClusterRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 type: oneOf: - type: integer - $ref: '#/components/schemas/BriefClusterTypeRequest' group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefClusterGroupRequest' nullable: true nullable: true status: enum: - planned - staging - active - decommissioning - offline type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `offline` - Offline' x-spec-enum-id: 65a25166053759eb tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true scope_type: type: string nullable: true scope_id: 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: {} 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 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 BriefVirtualMachineRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 64 description: type: string maxLength: 200 required: - name ClusterRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 type: oneOf: - type: integer - $ref: '#/components/schemas/BriefClusterTypeRequest' group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefClusterGroupRequest' nullable: true nullable: true status: enum: - planned - staging - active - decommissioning - offline type: string description: '* `planned` - Planned * `staging` - Staging * `active` - Active * `decommissioning` - Decommissioning * `offline` - Offline' x-spec-enum-id: 65a25166053759eb tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true scope_type: type: string nullable: true scope_id: 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 - type ClusterTypeRequest: 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 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 PaginatedVirtualDiskList: 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/VirtualDisk' WritableVMInterfaceRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: virtual_machine: oneOf: - type: integer - $ref: '#/components/schemas/BriefVirtualMachineRequest' name: type: string minLength: 1 maxLength: 64 enabled: type: boolean parent: type: integer nullable: true title: Parent interface bridge: type: integer nullable: true title: Bridge interface mtu: type: integer maximum: 65536 minimum: 1 nullable: true primary_mac_address: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefMACAddressRequest' nullable: true nullable: true 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)' 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 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: - name - virtual_machine VMInterfaceRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: virtual_machine: oneOf: - type: integer - $ref: '#/components/schemas/BriefVirtualMachineRequest' name: type: string minLength: 1 maxLength: 64 enabled: type: boolean parent: allOf: - $ref: '#/components/schemas/NestedVMInterfaceRequest' nullable: true bridge: allOf: - $ref: '#/components/schemas/NestedVMInterfaceRequest' 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 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 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 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: - name - virtual_machine 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 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 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 BriefVirtualMachine: 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 description: type: string maxLength: 200 required: - display - id - name - url 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 NestedVMInterfaceRequest: 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 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 VirtualMachineWithConfigContext: 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 status: type: object properties: value: enum: - offline - active - planned - staged - failed - decommissioning - paused type: string description: '* `offline` - Offline * `active` - Active * `planned` - Planned * `staged` - Staged * `failed` - Failed * `decommissioning` - Decommissioning * `paused` - Paused' x-spec-enum-id: effecc3b94e0b74b label: type: string enum: - Offline - Active - Planned - Staged - Failed - Decommissioning - Paused start_on_boot: type: object properties: value: enum: - 'on' - 'off' - laststate type: string description: '* `on` - On * `off` - Off * `laststate` - Last State' x-spec-enum-id: 610e33fc2fde73d6 label: type: string enum: - 'On' - 'Off' - Last State site: allOf: - $ref: '#/components/schemas/BriefSite' nullable: true cluster: allOf: - $ref: '#/components/schemas/BriefCluster' nullable: true device: allOf: - $ref: '#/components/schemas/BriefDevice' nullable: true serial: type: string title: Serial number maxLength: 50 role: allOf: - $ref: '#/components/schemas/BriefDeviceRole' nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true platform: allOf: - $ref: '#/components/schemas/BriefPlatform' 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 vcpus: type: number format: double maximum: 10000 minimum: 0.01 exclusiveMaximum: true nullable: true memory: type: integer maximum: 2147483647 minimum: 0 nullable: true disk: type: integer maximum: 2147483647 minimum: 0 nullable: true 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: {} config_context: nullable: true readOnly: true 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 readOnly: true virtual_disk_count: type: integer readOnly: true required: - config_context - created - display - display_url - id - interface_count - last_updated - name - primary_ip - url - virtual_disk_count 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 PatchedVirtualDiskRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: virtual_machine: oneOf: - type: integer - $ref: '#/components/schemas/BriefVirtualMachineRequest' name: type: string minLength: 1 maxLength: 64 description: type: string maxLength: 200 size: type: integer maximum: 2147483647 minimum: 0 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: {} 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 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 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 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 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 VMInterface: 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 virtual_machine: $ref: '#/components/schemas/BriefVirtualMachine' name: type: string maxLength: 64 enabled: type: boolean parent: allOf: - $ref: '#/components/schemas/NestedVMInterface' nullable: true bridge: allOf: - $ref: '#/components/schemas/NestedVMInterface' 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 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) 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 vrf: allOf: - $ref: '#/components/schemas/BriefVRF' nullable: true l2vpn_termination: allOf: - $ref: '#/components/schemas/BriefL2VPNTermination' 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 count_ipaddresses: type: integer readOnly: true count_fhrp_groups: type: integer readOnly: true required: - count_fhrp_groups - count_ipaddresses - created - display - display_url - id - l2vpn_termination - last_updated - mac_address - mac_addresses - name - url - virtual_machine 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 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 securitySchemes: cookieAuth: type: apiKey in: cookie name: sessionid tokenAuth: type: apiKey in: header name: Authorization description: '`Token ` (v1) or `Bearer .` (v2)'