openapi: 3.0.3 info: title: NetBox REST authentication-check circuits API version: 4.5.9 (4.5) license: name: Apache v2 License servers: - url: '' description: NetBox tags: - name: circuits paths: /api/circuits/circuit-group-assignments/: get: operationId: circuits_circuit_group_assignments_list description: Get a list of Circuit group assignment objects. parameters: - in: query name: circuit schema: type: array items: type: string explode: true style: form - in: query name: circuit_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: group schema: type: array items: type: string description: Circuit group (slug) explode: true style: form - in: query name: group__n schema: type: array items: type: string description: Circuit group (slug) explode: true style: form - in: query name: group_id schema: type: array items: type: integer description: Circuit group (ID) explode: true style: form - in: query name: group_id__n schema: type: array items: type: integer description: Circuit 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: member_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: member_id__empty schema: type: boolean - in: query name: member_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: member_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: member_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: member_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: member_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: member_type schema: type: array items: type: string explode: true style: form - in: query name: member_type__n schema: type: array items: type: string explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: priority schema: type: string x-spec-enum-id: 0548fc537440bf9d nullable: true enum: - inactive - 'null' - primary - secondary - tertiary description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' - in: query name: priority__empty schema: type: boolean - in: query name: priority__ic schema: type: array items: type: string explode: true style: form - in: query name: priority__ie schema: type: array items: type: string explode: true style: form - in: query name: priority__iew schema: type: array items: type: string explode: true style: form - in: query name: priority__iregex schema: type: array items: type: string explode: true style: form - in: query name: priority__isw schema: type: array items: type: string explode: true style: form - in: query name: priority__n schema: type: string x-spec-enum-id: 0548fc537440bf9d nullable: true enum: - inactive - 'null' - primary - secondary - tertiary description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' - in: query name: priority__nic schema: type: array items: type: string explode: true style: form - in: query name: priority__nie schema: type: array items: type: string explode: true style: form - in: query name: priority__niew schema: type: array items: type: string explode: true style: form - in: query name: priority__nisw schema: type: array items: type: string explode: true style: form - in: query name: priority__regex schema: type: array items: type: string explode: true style: form - in: query name: provider schema: type: array items: type: string explode: true style: form - in: query name: provider_id schema: type: array items: type: integer format: int32 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_circuit schema: type: array items: type: string explode: true style: form - in: query name: virtual_circuit_id schema: type: array items: type: integer format: int32 explode: true style: form tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCircuitGroupAssignmentList' description: '' post: operationId: circuits_circuit_group_assignments_create description: Post a list of Circuit group assignment objects. tags: - circuits requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' - type: array items: $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' - type: array items: $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CircuitGroupAssignment' description: '' put: operationId: circuits_circuit_group_assignments_bulk_update description: Put a list of Circuit group assignment objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitGroupAssignmentRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitGroupAssignmentRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitGroupAssignment' description: '' patch: operationId: circuits_circuit_group_assignments_bulk_partial_update description: Patch a list of Circuit group assignment objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitGroupAssignmentRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitGroupAssignmentRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitGroupAssignment' description: '' delete: operationId: circuits_circuit_group_assignments_bulk_destroy description: Delete a list of Circuit group assignment objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitGroupAssignmentRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitGroupAssignmentRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/circuit-group-assignments/{id}/: get: operationId: circuits_circuit_group_assignments_retrieve description: Get a Circuit group assignment object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Circuit group assignment. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitGroupAssignment' description: '' put: operationId: circuits_circuit_group_assignments_update description: Put a Circuit group assignment object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Circuit group assignment. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableCircuitGroupAssignmentRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitGroupAssignment' description: '' patch: operationId: circuits_circuit_group_assignments_partial_update description: Patch a Circuit group assignment object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Circuit group assignment. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableCircuitGroupAssignmentRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableCircuitGroupAssignmentRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitGroupAssignment' description: '' delete: operationId: circuits_circuit_group_assignments_destroy description: Delete a Circuit group assignment object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Circuit group assignment. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/circuit-groups/: get: operationId: circuits_circuit_groups_list description: Get a list of circuit group 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: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCircuitGroupList' description: '' post: operationId: circuits_circuit_groups_create description: Post a list of circuit group objects. tags: - circuits requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/CircuitGroupRequest' - type: array items: $ref: '#/components/schemas/CircuitGroupRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/CircuitGroupRequest' - type: array items: $ref: '#/components/schemas/CircuitGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CircuitGroup' description: '' put: operationId: circuits_circuit_groups_bulk_update description: Put a list of circuit group objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitGroup' description: '' patch: operationId: circuits_circuit_groups_bulk_partial_update description: Patch a list of circuit group objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitGroup' description: '' delete: operationId: circuits_circuit_groups_bulk_destroy description: Delete a list of circuit group objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/circuit-groups/{id}/: get: operationId: circuits_circuit_groups_retrieve description: Get a circuit group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit group. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitGroup' description: '' put: operationId: circuits_circuit_groups_update description: Put a circuit group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit group. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/CircuitGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/CircuitGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitGroup' description: '' patch: operationId: circuits_circuit_groups_partial_update description: Patch a circuit group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit group. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCircuitGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedCircuitGroupRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitGroup' description: '' delete: operationId: circuits_circuit_groups_destroy description: Delete a circuit group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit group. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/circuit-terminations/: get: operationId: circuits_circuit_terminations_list description: Get a list of circuit termination objects. parameters: - in: query name: cable_connector schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__empty schema: type: boolean - in: query name: cable_connector__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_connector__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: cable_end schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__empty schema: type: boolean - in: query name: cable_end__ic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__ie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__iregex schema: type: array items: type: string explode: true style: form - in: query name: cable_end__isw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__n schema: type: string x-spec-enum-id: 1db84f9b93b261c8 nullable: true enum: - A - B - 'null' description: '* `A` - A * `B` - B' - in: query name: cable_end__nic schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nie schema: type: array items: type: string explode: true style: form - in: query name: cable_end__niew schema: type: array items: type: string explode: true style: form - in: query name: cable_end__nisw schema: type: array items: type: string explode: true style: form - in: query name: cable_end__regex schema: type: array items: type: string explode: true style: form - in: query name: cable_id schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cable_id__n schema: type: array items: type: integer nullable: true description: Cable (ID) explode: true style: form - in: query name: cabled schema: type: boolean - in: query name: circuit_id schema: type: array items: type: integer description: Circuit explode: true style: form - in: query name: circuit_id__n schema: type: array items: type: integer description: Circuit explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location 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: mark_connected schema: type: boolean - in: query name: modified_by_request schema: type: string format: uuid - in: query name: occupied schema: type: boolean - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: port_speed schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: port_speed__empty schema: type: boolean - in: query name: port_speed__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: port_speed__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: port_speed__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: port_speed__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: port_speed__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: pp_info schema: type: array items: type: string explode: true style: form - in: query name: pp_info__empty schema: type: boolean - in: query name: pp_info__ic schema: type: array items: type: string explode: true style: form - in: query name: pp_info__ie schema: type: array items: type: string explode: true style: form - in: query name: pp_info__iew schema: type: array items: type: string explode: true style: form - in: query name: pp_info__iregex schema: type: array items: type: string explode: true style: form - in: query name: pp_info__isw schema: type: array items: type: string explode: true style: form - in: query name: pp_info__n schema: type: array items: type: string explode: true style: form - in: query name: pp_info__nic schema: type: array items: type: string explode: true style: form - in: query name: pp_info__nie schema: type: array items: type: string explode: true style: form - in: query name: pp_info__niew schema: type: array items: type: string explode: true style: form - in: query name: pp_info__nisw schema: type: array items: type: string explode: true style: form - in: query name: pp_info__regex schema: type: array items: type: string explode: true style: form - in: query name: provider schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider__n schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider_id schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: provider_id__n schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: provider_network_id schema: type: array items: type: integer description: ProviderNetwork (ID) explode: true style: form - in: query name: provider_network_id__n schema: type: array items: type: integer description: ProviderNetwork (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: 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: term_side schema: type: string x-spec-enum-id: 95b8fcc737f355d0 title: Termination side enum: - A - Z - 'null' description: '* `A` - A * `Z` - Z' - in: query name: term_side__empty schema: type: boolean - in: query name: term_side__ic schema: type: array items: type: string explode: true style: form - in: query name: term_side__ie schema: type: array items: type: string explode: true style: form - in: query name: term_side__iew schema: type: array items: type: string explode: true style: form - in: query name: term_side__iregex schema: type: array items: type: string explode: true style: form - in: query name: term_side__isw schema: type: array items: type: string explode: true style: form - in: query name: term_side__n schema: type: string x-spec-enum-id: 95b8fcc737f355d0 title: Termination side enum: - A - Z - 'null' description: '* `A` - A * `Z` - Z' - in: query name: term_side__nic schema: type: array items: type: string explode: true style: form - in: query name: term_side__nie schema: type: array items: type: string explode: true style: form - in: query name: term_side__niew schema: type: array items: type: string explode: true style: form - in: query name: term_side__nisw schema: type: array items: type: string explode: true style: form - in: query name: term_side__regex schema: type: array items: type: string explode: true style: form - in: query name: termination_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__empty schema: type: boolean - in: query name: termination_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_type schema: type: array items: type: string explode: true style: form - in: query name: termination_type__n schema: type: array items: type: string explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: upstream_speed schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: upstream_speed__empty schema: type: boolean - in: query name: upstream_speed__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: upstream_speed__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: upstream_speed__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: upstream_speed__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: upstream_speed__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: xconnect_id schema: type: array items: type: string explode: true style: form - in: query name: xconnect_id__empty schema: type: boolean - in: query name: xconnect_id__ic schema: type: array items: type: string explode: true style: form - in: query name: xconnect_id__ie schema: type: array items: type: string explode: true style: form - in: query name: xconnect_id__iew schema: type: array items: type: string explode: true style: form - in: query name: xconnect_id__iregex schema: type: array items: type: string explode: true style: form - in: query name: xconnect_id__isw schema: type: array items: type: string explode: true style: form - in: query name: xconnect_id__n schema: type: array items: type: string explode: true style: form - in: query name: xconnect_id__nic schema: type: array items: type: string explode: true style: form - in: query name: xconnect_id__nie schema: type: array items: type: string explode: true style: form - in: query name: xconnect_id__niew schema: type: array items: type: string explode: true style: form - in: query name: xconnect_id__nisw schema: type: array items: type: string explode: true style: form - in: query name: xconnect_id__regex schema: type: array items: type: string explode: true style: form tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCircuitTerminationList' description: '' post: operationId: circuits_circuit_terminations_create description: Post a list of circuit termination objects. tags: - circuits requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/CircuitTerminationRequest' - type: array items: $ref: '#/components/schemas/CircuitTerminationRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/CircuitTerminationRequest' - type: array items: $ref: '#/components/schemas/CircuitTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' description: '' put: operationId: circuits_circuit_terminations_bulk_update description: Put a list of circuit termination objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitTermination' description: '' patch: operationId: circuits_circuit_terminations_bulk_partial_update description: Patch a list of circuit termination objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitTermination' description: '' delete: operationId: circuits_circuit_terminations_bulk_destroy description: Delete a list of circuit termination objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/circuit-terminations/{id}/: get: operationId: circuits_circuit_terminations_retrieve description: Get a circuit termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit termination. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' description: '' put: operationId: circuits_circuit_terminations_update description: Put a circuit termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit termination. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/CircuitTerminationRequest' multipart/form-data: schema: $ref: '#/components/schemas/CircuitTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' description: '' patch: operationId: circuits_circuit_terminations_partial_update description: Patch a circuit termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit termination. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCircuitTerminationRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedCircuitTerminationRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' description: '' delete: operationId: circuits_circuit_terminations_destroy description: Delete a circuit termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit termination. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/circuit-terminations/{id}/paths/: get: operationId: circuits_circuit_terminations_paths_retrieve description: Return all CablePaths which traverse a given pass-through port. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit termination. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitTermination' description: '' /api/circuits/circuit-types/: get: operationId: circuits_circuit_types_list description: Get a list of circuit type objects. parameters: - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCircuitTypeList' description: '' post: operationId: circuits_circuit_types_create description: Post a list of circuit type objects. tags: - circuits requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/CircuitTypeRequest' - type: array items: $ref: '#/components/schemas/CircuitTypeRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/CircuitTypeRequest' - type: array items: $ref: '#/components/schemas/CircuitTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CircuitType' description: '' put: operationId: circuits_circuit_types_bulk_update description: Put a list of circuit type objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitType' description: '' patch: operationId: circuits_circuit_types_bulk_partial_update description: Patch a list of circuit type objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitType' description: '' delete: operationId: circuits_circuit_types_bulk_destroy description: Delete a list of circuit type objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/circuit-types/{id}/: get: operationId: circuits_circuit_types_retrieve description: Get a circuit type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit type. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitType' description: '' put: operationId: circuits_circuit_types_update description: Put a circuit type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit type. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/CircuitTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/CircuitTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitType' description: '' patch: operationId: circuits_circuit_types_partial_update description: Patch a circuit type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit type. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCircuitTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedCircuitTypeRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CircuitType' description: '' delete: operationId: circuits_circuit_types_destroy description: Delete a circuit type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit type. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/circuits/: get: operationId: circuits_circuits_list description: Get a list of circuit objects. parameters: - in: query name: cid schema: type: array items: type: string explode: true style: form - in: query name: cid__empty schema: type: boolean - in: query name: cid__ic schema: type: array items: type: string explode: true style: form - in: query name: cid__ie schema: type: array items: type: string explode: true style: form - in: query name: cid__iew schema: type: array items: type: string explode: true style: form - in: query name: cid__iregex schema: type: array items: type: string explode: true style: form - in: query name: cid__isw schema: type: array items: type: string explode: true style: form - in: query name: cid__n schema: type: array items: type: string explode: true style: form - in: query name: cid__nic schema: type: array items: type: string explode: true style: form - in: query name: cid__nie schema: type: array items: type: string explode: true style: form - in: query name: cid__niew schema: type: array items: type: string explode: true style: form - in: query name: cid__nisw schema: type: array items: type: string explode: true style: form - in: query name: cid__regex schema: type: array items: type: string explode: true style: form - in: query name: commit_rate schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: commit_rate__empty schema: type: boolean - in: query name: commit_rate__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: commit_rate__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: commit_rate__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: commit_rate__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: commit_rate__n schema: type: array items: type: integer format: int32 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: distance schema: type: array items: type: number format: double explode: true style: form - in: query name: distance__empty schema: type: boolean - in: query name: distance__gt schema: type: array items: type: number format: double explode: true style: form - in: query name: distance__gte schema: type: array items: type: number format: double explode: true style: form - in: query name: distance__lt schema: type: array items: type: number format: double explode: true style: form - in: query name: distance__lte schema: type: array items: type: number format: double explode: true style: form - in: query name: distance__n schema: type: array items: type: number format: double explode: true style: form - in: query name: distance_unit schema: type: string x-spec-enum-id: b1169a409430c02e nullable: true enum: - ft - km - m - mi - 'null' description: '* `km` - Kilometers * `m` - Meters * `mi` - Miles * `ft` - Feet' - in: query name: distance_unit__empty schema: type: boolean - in: query name: distance_unit__ic schema: type: array items: type: string explode: true style: form - in: query name: distance_unit__ie schema: type: array items: type: string explode: true style: form - in: query name: distance_unit__iew schema: type: array items: type: string explode: true style: form - in: query name: distance_unit__iregex schema: type: array items: type: string explode: true style: form - in: query name: distance_unit__isw schema: type: array items: type: string explode: true style: form - in: query name: distance_unit__n schema: type: string x-spec-enum-id: b1169a409430c02e nullable: true enum: - ft - km - m - mi - 'null' description: '* `km` - Kilometers * `m` - Meters * `mi` - Miles * `ft` - Feet' - in: query name: distance_unit__nic schema: type: array items: type: string explode: true style: form - in: query name: distance_unit__nie schema: type: array items: type: string explode: true style: form - in: query name: distance_unit__niew schema: type: array items: type: string explode: true style: form - in: query name: distance_unit__nisw schema: type: array items: type: string explode: true style: form - in: query name: distance_unit__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: install_date schema: type: array items: type: string format: date explode: true style: form - in: query name: install_date__empty schema: type: boolean - in: query name: install_date__gt schema: type: array items: type: string format: date explode: true style: form - in: query name: install_date__gte schema: type: array items: type: string format: date explode: true style: form - in: query name: install_date__lt schema: type: array items: type: string format: date explode: true style: form - in: query name: install_date__lte schema: type: array items: type: string format: date explode: true style: form - in: query name: install_date__n schema: type: array items: type: string format: date explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location_id schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: location_id__n schema: type: array items: type: integer description: Location (ID) explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - 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: provider schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider__n schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider_account schema: type: array items: type: string title: Account ID description: Provider account (account) explode: true style: form - in: query name: provider_account__n schema: type: array items: type: string title: Account ID description: Provider account (account) explode: true style: form - in: query name: provider_account_id schema: type: array items: type: integer description: Provider account (ID) explode: true style: form - in: query name: provider_account_id__n schema: type: array items: type: integer description: Provider account (ID) explode: true style: form - in: query name: provider_id schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: provider_id__n schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: provider_network_id schema: type: array items: type: integer description: Provider network (ID) explode: true style: form - in: query name: provider_network_id__n schema: type: array items: type: integer description: Provider network (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 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: 0a239d878b6666a4 explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: termination_a_id schema: type: array items: type: integer nullable: true description: Termination A (ID) explode: true style: form - in: query name: termination_a_id__n schema: type: array items: type: integer nullable: true description: Termination A (ID) explode: true style: form - in: query name: termination_date schema: type: array items: type: string format: date explode: true style: form - in: query name: termination_date__empty schema: type: boolean - in: query name: termination_date__gt schema: type: array items: type: string format: date explode: true style: form - in: query name: termination_date__gte schema: type: array items: type: string format: date explode: true style: form - in: query name: termination_date__lt schema: type: array items: type: string format: date explode: true style: form - in: query name: termination_date__lte schema: type: array items: type: string format: date explode: true style: form - in: query name: termination_date__n schema: type: array items: type: string format: date explode: true style: form - in: query name: termination_z_id schema: type: array items: type: integer nullable: true description: Termination A (ID) explode: true style: form - in: query name: termination_z_id__n schema: type: array items: type: integer nullable: true description: Termination A (ID) explode: true style: form - in: query name: type schema: type: array items: type: string description: Circuit type (slug) explode: true style: form - in: query name: type__n schema: type: array items: type: string description: Circuit type (slug) explode: true style: form - in: query name: type_id schema: type: array items: type: integer description: Circuit type (ID) explode: true style: form - in: query name: type_id__n schema: type: array items: type: integer description: Circuit type (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCircuitList' description: '' post: operationId: circuits_circuits_create description: Post a list of circuit objects. tags: - circuits requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableCircuitRequest' - type: array items: $ref: '#/components/schemas/WritableCircuitRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableCircuitRequest' - type: array items: $ref: '#/components/schemas/WritableCircuitRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Circuit' description: '' put: operationId: circuits_circuits_bulk_update description: Put a list of circuit objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Circuit' description: '' patch: operationId: circuits_circuits_bulk_partial_update description: Patch a list of circuit objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Circuit' description: '' delete: operationId: circuits_circuits_bulk_destroy description: Delete a list of circuit objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CircuitRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CircuitRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/circuits/{id}/: get: operationId: circuits_circuits_retrieve description: Get a circuit object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Circuit' description: '' put: operationId: circuits_circuits_update description: Put a circuit object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCircuitRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableCircuitRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Circuit' description: '' patch: operationId: circuits_circuits_partial_update description: Patch a circuit object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableCircuitRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableCircuitRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Circuit' description: '' delete: operationId: circuits_circuits_destroy description: Delete a circuit object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this circuit. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/provider-accounts/: get: operationId: circuits_provider_accounts_list description: Get a list of provider account objects. parameters: - in: query name: account schema: type: array items: type: string explode: true style: form - in: query name: account__empty schema: type: boolean - in: query name: account__ic schema: type: array items: type: string explode: true style: form - in: query name: account__ie schema: type: array items: type: string explode: true style: form - in: query name: account__iew schema: type: array items: type: string explode: true style: form - in: query name: account__iregex schema: type: array items: type: string explode: true style: form - in: query name: account__isw schema: type: array items: type: string explode: true style: form - in: query name: account__n schema: type: array items: type: string explode: true style: form - in: query name: account__nic schema: type: array items: type: string explode: true style: form - in: query name: account__nie schema: type: array items: type: string explode: true style: form - in: query name: account__niew schema: type: array items: type: string explode: true style: form - in: query name: account__nisw schema: type: array items: type: string explode: true style: form - in: query name: account__regex schema: type: array items: type: string explode: true style: form - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: 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: provider schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider__n schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider_id schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: provider_id__n schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedProviderAccountList' description: '' post: operationId: circuits_provider_accounts_create description: Post a list of provider account objects. tags: - circuits requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ProviderAccountRequest' - type: array items: $ref: '#/components/schemas/ProviderAccountRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/ProviderAccountRequest' - type: array items: $ref: '#/components/schemas/ProviderAccountRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProviderAccount' description: '' put: operationId: circuits_provider_accounts_bulk_update description: Put a list of provider account objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderAccountRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ProviderAccountRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderAccount' description: '' patch: operationId: circuits_provider_accounts_bulk_partial_update description: Patch a list of provider account objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderAccountRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ProviderAccountRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderAccount' description: '' delete: operationId: circuits_provider_accounts_bulk_destroy description: Delete a list of provider account objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderAccountRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ProviderAccountRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/provider-accounts/{id}/: get: operationId: circuits_provider_accounts_retrieve description: Get a provider account object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider account. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderAccount' description: '' put: operationId: circuits_provider_accounts_update description: Put a provider account object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider account. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderAccountRequest' multipart/form-data: schema: $ref: '#/components/schemas/ProviderAccountRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderAccount' description: '' patch: operationId: circuits_provider_accounts_partial_update description: Patch a provider account object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider account. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProviderAccountRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedProviderAccountRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderAccount' description: '' delete: operationId: circuits_provider_accounts_destroy description: Delete a provider account object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider account. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/provider-networks/: get: operationId: circuits_provider_networks_list description: Get a list of provider network 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: provider schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider__n schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider_id schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: provider_id__n schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: service_id schema: type: array items: type: string explode: true style: form - in: query name: service_id__empty schema: type: boolean - in: query name: service_id__ic schema: type: array items: type: string explode: true style: form - in: query name: service_id__ie schema: type: array items: type: string explode: true style: form - in: query name: service_id__iew schema: type: array items: type: string explode: true style: form - in: query name: service_id__iregex schema: type: array items: type: string explode: true style: form - in: query name: service_id__isw schema: type: array items: type: string explode: true style: form - in: query name: service_id__n schema: type: array items: type: string explode: true style: form - in: query name: service_id__nic schema: type: array items: type: string explode: true style: form - in: query name: service_id__nie schema: type: array items: type: string explode: true style: form - in: query name: service_id__niew schema: type: array items: type: string explode: true style: form - in: query name: service_id__nisw schema: type: array items: type: string explode: true style: form - in: query name: service_id__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: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedProviderNetworkList' description: '' post: operationId: circuits_provider_networks_create description: Post a list of provider network objects. tags: - circuits requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ProviderNetworkRequest' - type: array items: $ref: '#/components/schemas/ProviderNetworkRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/ProviderNetworkRequest' - type: array items: $ref: '#/components/schemas/ProviderNetworkRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProviderNetwork' description: '' put: operationId: circuits_provider_networks_bulk_update description: Put a list of provider network objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderNetworkRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ProviderNetworkRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderNetwork' description: '' patch: operationId: circuits_provider_networks_bulk_partial_update description: Patch a list of provider network objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderNetworkRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ProviderNetworkRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderNetwork' description: '' delete: operationId: circuits_provider_networks_bulk_destroy description: Delete a list of provider network objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderNetworkRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ProviderNetworkRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/provider-networks/{id}/: get: operationId: circuits_provider_networks_retrieve description: Get a provider network object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider network. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderNetwork' description: '' put: operationId: circuits_provider_networks_update description: Put a provider network object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider network. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderNetworkRequest' multipart/form-data: schema: $ref: '#/components/schemas/ProviderNetworkRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderNetwork' description: '' patch: operationId: circuits_provider_networks_partial_update description: Patch a provider network object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider network. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProviderNetworkRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedProviderNetworkRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProviderNetwork' description: '' delete: operationId: circuits_provider_networks_destroy description: Delete a provider network object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider network. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/providers/: get: operationId: circuits_providers_list description: Get a list of provider objects. parameters: - in: query name: asn schema: type: array items: type: integer maximum: 4294967295 minimum: 1 format: int64 description: ASN explode: true style: form - in: query name: asn__n schema: type: array items: type: integer maximum: 4294967295 minimum: 1 format: int64 description: ASN explode: true style: form - in: query name: asn_id schema: type: array items: type: integer description: ASN (ID) explode: true style: form - in: query name: asn_id__n schema: type: array items: type: integer description: ASN (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: 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: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site explode: true style: form - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: 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: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedProviderList' description: '' post: operationId: circuits_providers_create description: Post a list of provider objects. tags: - circuits requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ProviderRequest' - type: array items: $ref: '#/components/schemas/ProviderRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/ProviderRequest' - type: array items: $ref: '#/components/schemas/ProviderRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Provider' description: '' put: operationId: circuits_providers_bulk_update description: Put a list of provider objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ProviderRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Provider' description: '' patch: operationId: circuits_providers_bulk_partial_update description: Patch a list of provider objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ProviderRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Provider' description: '' delete: operationId: circuits_providers_bulk_destroy description: Delete a list of provider objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ProviderRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ProviderRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/providers/{id}/: get: operationId: circuits_providers_retrieve description: Get a provider object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Provider' description: '' put: operationId: circuits_providers_update description: Put a provider object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRequest' multipart/form-data: schema: $ref: '#/components/schemas/ProviderRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Provider' description: '' patch: operationId: circuits_providers_partial_update description: Patch a provider object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProviderRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedProviderRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Provider' description: '' delete: operationId: circuits_providers_destroy description: Delete a provider object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this provider. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/virtual-circuit-terminations/: get: operationId: circuits_virtual_circuit_terminations_list description: Get a list of virtual circuit termination 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: interface_id schema: type: array items: type: integer description: Interface (ID) explode: true style: form - in: query name: interface_id__n schema: type: array items: type: integer description: Interface (ID) explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - 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: provider schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider__n schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider_account schema: type: array items: type: string title: Account ID description: Provider account (account) explode: true style: form - in: query name: provider_account__n schema: type: array items: type: string title: Account ID description: Provider account (account) explode: true style: form - in: query name: provider_account_id schema: type: array items: type: integer description: Provider account (ID) explode: true style: form - in: query name: provider_account_id__n schema: type: array items: type: integer description: Provider account (ID) explode: true style: form - in: query name: provider_id schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: provider_id__n schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: provider_network_id schema: type: array items: type: integer description: Provider network (ID) explode: true style: form - in: query name: provider_network_id__n schema: type: array items: type: integer description: Provider network (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: role schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__empty schema: type: boolean - in: query name: role__ic schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__ie schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__iew schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__iregex schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__isw schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__n schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__nic schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__nie schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__niew schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__nisw schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__regex schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 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_circuit_id schema: type: array items: type: integer description: Virtual circuit explode: true style: form - in: query name: virtual_circuit_id__n schema: type: array items: type: integer description: Virtual circuit explode: true style: form tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVirtualCircuitTerminationList' description: '' post: operationId: circuits_virtual_circuit_terminations_create description: Post a list of virtual circuit termination objects. tags: - circuits requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' - type: array items: $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' - type: array items: $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuitTermination' description: '' put: operationId: circuits_virtual_circuit_terminations_bulk_update description: Put a list of virtual circuit termination objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTermination' description: '' patch: operationId: circuits_virtual_circuit_terminations_bulk_partial_update description: Patch a list of virtual circuit termination objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTermination' description: '' delete: operationId: circuits_virtual_circuit_terminations_bulk_destroy description: Delete a list of virtual circuit termination objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/virtual-circuit-terminations/{id}/: get: operationId: circuits_virtual_circuit_terminations_retrieve description: Get a virtual circuit termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit termination. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuitTermination' description: '' put: operationId: circuits_virtual_circuit_terminations_update description: Put a virtual circuit termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit termination. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableVirtualCircuitTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuitTermination' description: '' patch: operationId: circuits_virtual_circuit_terminations_partial_update description: Patch a virtual circuit termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit termination. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVirtualCircuitTerminationRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableVirtualCircuitTerminationRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuitTermination' description: '' delete: operationId: circuits_virtual_circuit_terminations_destroy description: Delete a virtual circuit termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit termination. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/virtual-circuit-terminations/{id}/paths/: get: operationId: circuits_virtual_circuit_terminations_paths_retrieve description: Return all CablePaths which traverse a given pass-through port. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit termination. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuitTermination' description: '' /api/circuits/virtual-circuit-types/: get: operationId: circuits_virtual_circuit_types_list description: Get a list of virtual circuit type objects. parameters: - in: query name: color schema: type: array items: type: string explode: true style: form - in: query name: color__empty schema: type: boolean - in: query name: color__ic schema: type: array items: type: string explode: true style: form - in: query name: color__ie schema: type: array items: type: string explode: true style: form - in: query name: color__iew schema: type: array items: type: string explode: true style: form - in: query name: color__iregex schema: type: array items: type: string explode: true style: form - in: query name: color__isw schema: type: array items: type: string explode: true style: form - in: query name: color__n schema: type: array items: type: string explode: true style: form - in: query name: color__nic schema: type: array items: type: string explode: true style: form - in: query name: color__nie schema: type: array items: type: string explode: true style: form - in: query name: color__niew schema: type: array items: type: string explode: true style: form - in: query name: color__nisw schema: type: array items: type: string explode: true style: form - in: query name: color__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVirtualCircuitTypeList' description: '' post: operationId: circuits_virtual_circuit_types_create description: Post a list of virtual circuit type objects. tags: - circuits requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/VirtualCircuitTypeRequest' - type: array items: $ref: '#/components/schemas/VirtualCircuitTypeRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/VirtualCircuitTypeRequest' - type: array items: $ref: '#/components/schemas/VirtualCircuitTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuitType' description: '' put: operationId: circuits_virtual_circuit_types_bulk_update description: Put a list of virtual circuit type objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitType' description: '' patch: operationId: circuits_virtual_circuit_types_bulk_partial_update description: Patch a list of virtual circuit type objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitType' description: '' delete: operationId: circuits_virtual_circuit_types_bulk_destroy description: Delete a list of virtual circuit type objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTypeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/virtual-circuit-types/{id}/: get: operationId: circuits_virtual_circuit_types_retrieve description: Get a virtual circuit type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit type. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuitType' description: '' put: operationId: circuits_virtual_circuit_types_update description: Put a virtual circuit type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit type. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/VirtualCircuitTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/VirtualCircuitTypeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuitType' description: '' patch: operationId: circuits_virtual_circuit_types_partial_update description: Patch a virtual circuit type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit type. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedVirtualCircuitTypeRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedVirtualCircuitTypeRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuitType' description: '' delete: operationId: circuits_virtual_circuit_types_destroy description: Delete a virtual circuit type object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit type. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/virtual-circuits/: get: operationId: circuits_virtual_circuits_list description: Get a list of virtual circuit objects. parameters: - in: query name: cid schema: type: array items: type: string explode: true style: form - in: query name: cid__empty schema: type: boolean - in: query name: cid__ic schema: type: array items: type: string explode: true style: form - in: query name: cid__ie schema: type: array items: type: string explode: true style: form - in: query name: cid__iew schema: type: array items: type: string explode: true style: form - in: query name: cid__iregex schema: type: array items: type: string explode: true style: form - in: query name: cid__isw schema: type: array items: type: string explode: true style: form - in: query name: cid__n schema: type: array items: type: string explode: true style: form - in: query name: cid__nic schema: type: array items: type: string explode: true style: form - in: query name: cid__nie schema: type: array items: type: string explode: true style: form - in: query name: cid__niew schema: type: array items: type: string explode: true style: form - in: query name: cid__nisw schema: type: array items: type: string explode: true style: form - in: query name: cid__regex schema: type: array items: type: string explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - 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: provider schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider__n schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider_account schema: type: array items: type: string title: Account ID description: Provider account (account) explode: true style: form - in: query name: provider_account__n schema: type: array items: type: string title: Account ID description: Provider account (account) explode: true style: form - in: query name: provider_account_id schema: type: array items: type: integer description: Provider account (ID) explode: true style: form - in: query name: provider_account_id__n schema: type: array items: type: integer description: Provider account (ID) explode: true style: form - in: query name: provider_id schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: provider_id__n schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: provider_network_id schema: type: array items: type: integer description: Provider network (ID) explode: true style: form - in: query name: provider_network_id__n schema: type: array items: type: integer description: Provider network (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: status schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 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: 0a239d878b6666a4 explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 0a239d878b6666a4 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: Virtual circuit type (slug) explode: true style: form - in: query name: type__n schema: type: array items: type: string description: Virtual circuit type (slug) explode: true style: form - in: query name: type_id schema: type: array items: type: integer description: Virtual circuit type (ID) explode: true style: form - in: query name: type_id__n schema: type: array items: type: integer description: Virtual circuit type (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVirtualCircuitList' description: '' post: operationId: circuits_virtual_circuits_create description: Post a list of virtual circuit objects. tags: - circuits requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableVirtualCircuitRequest' - type: array items: $ref: '#/components/schemas/WritableVirtualCircuitRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableVirtualCircuitRequest' - type: array items: $ref: '#/components/schemas/WritableVirtualCircuitRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuit' description: '' put: operationId: circuits_virtual_circuits_bulk_update description: Put a list of virtual circuit objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuit' description: '' patch: operationId: circuits_virtual_circuits_bulk_partial_update description: Patch a list of virtual circuit objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuit' description: '' delete: operationId: circuits_virtual_circuits_bulk_destroy description: Delete a list of virtual circuit objects. tags: - circuits requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VirtualCircuitRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/circuits/virtual-circuits/{id}/: get: operationId: circuits_virtual_circuits_retrieve description: Get a virtual circuit object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuit' description: '' put: operationId: circuits_virtual_circuits_update description: Put a virtual circuit object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVirtualCircuitRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableVirtualCircuitRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuit' description: '' patch: operationId: circuits_virtual_circuits_partial_update description: Patch a virtual circuit object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit. required: true tags: - circuits requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVirtualCircuitRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableVirtualCircuitRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VirtualCircuit' description: '' delete: operationId: circuits_virtual_circuits_destroy description: Delete a virtual circuit object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this virtual circuit. required: true tags: - circuits security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body components: schemas: BriefProviderNetwork: 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 PatchedVirtualCircuitTypeRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefProviderNetworkRequest: 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 BriefCircuitGroupAssignmentSerializer_Request: type: object description: Base serializer for group assignments under CircuitSerializer. properties: group: oneOf: - type: integer - $ref: '#/components/schemas/BriefCircuitGroupRequest' priority: enum: - primary - secondary - tertiary - inactive - '' type: string description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' x-spec-enum-id: 0548fc537440bf9d required: - group Provider: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string description: Full name of the provider maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ accounts: type: array items: $ref: '#/components/schemas/NestedProviderAccount' description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string asns: type: array items: $ref: '#/components/schemas/ASN' tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true circuit_count: type: integer format: int64 readOnly: true required: - circuit_count - created - display - display_url - id - last_updated - name - slug - url PaginatedProviderList: 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/Provider' PaginatedProviderAccountList: 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/ProviderAccount' PaginatedCircuitTerminationList: 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/CircuitTermination' PatchedProviderRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 description: Full name of the provider maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ accounts: type: array items: type: integer description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string asns: type: array items: type: integer tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} CircuitCircuitTermination: 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 termination_type: type: string nullable: true termination_id: type: integer nullable: true termination: readOnly: true nullable: true port_speed: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Port speed (Kbps) description: Physical circuit speed upstream_speed: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Upstream speed (Kbps) description: Upstream speed, if different from port speed xconnect_id: type: string title: Cross-connect ID description: ID of the local cross-connect maxLength: 50 description: type: string maxLength: 200 required: - display - display_url - id - termination - url PaginatedCircuitList: 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/Circuit' BriefVirtualCircuit: 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 cid: type: string title: Circuit ID description: Unique circuit ID maxLength: 100 provider_network: $ref: '#/components/schemas/BriefProviderNetwork' description: type: string maxLength: 200 required: - cid - display - id - provider_network - url BriefCircuit: 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 cid: type: string title: Circuit ID description: Unique circuit ID maxLength: 100 provider: $ref: '#/components/schemas/BriefProvider' description: type: string maxLength: 200 required: - cid - display - id - provider - url WritableVirtualCircuitTerminationRequest: type: object description: Adds support for custom fields and tags. properties: virtual_circuit: oneOf: - type: integer - $ref: '#/components/schemas/BriefVirtualCircuitRequest' role: enum: - peer - hub - spoke type: string description: '* `peer` - Peer * `hub` - Hub * `spoke` - Spoke' x-spec-enum-id: 0b3bfadcebd86b58 interface: oneOf: - type: integer - $ref: '#/components/schemas/BriefInterfaceRequest' description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - interface - virtual_circuit BriefProviderAccountRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string default: '' maxLength: 100 account: type: string minLength: 1 title: Account ID maxLength: 100 description: type: string maxLength: 200 required: - account 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 BriefProviderAccount: 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 default: '' maxLength: 100 account: type: string title: Account ID maxLength: 100 description: type: string maxLength: 200 required: - account - display - id - url VirtualCircuitTermination: type: object description: Adds support for custom fields and tags. 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_circuit: $ref: '#/components/schemas/BriefVirtualCircuit' role: type: object properties: value: enum: - peer - hub - spoke type: string description: '* `peer` - Peer * `hub` - Hub * `spoke` - Spoke' x-spec-enum-id: 0b3bfadcebd86b58 label: type: string enum: - Peer - Hub - Spoke interface: $ref: '#/components/schemas/BriefInterface' description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - interface - last_updated - url - virtual_circuit ProviderAccount: 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 provider: $ref: '#/components/schemas/BriefProvider' name: type: string default: '' maxLength: 100 account: type: string title: Account ID maxLength: 100 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - account - created - display - display_url - id - last_updated - provider - url WritableCircuitGroupAssignmentRequest: type: object description: Base serializer for group assignments under CircuitSerializer. properties: group: oneOf: - type: integer - $ref: '#/components/schemas/BriefCircuitGroupRequest' member_type: type: string member_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 priority: enum: - primary - secondary - tertiary - inactive - '' - null type: string description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' x-spec-enum-id: 0548fc537440bf9d nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' required: - group - member_id - member_type ProviderNetwork: 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 provider: $ref: '#/components/schemas/BriefProvider' name: type: string maxLength: 100 service_id: type: string maxLength: 100 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} 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 - provider - url VirtualCircuitRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: cid: type: string minLength: 1 title: Circuit ID description: Unique circuit ID maxLength: 100 provider_network: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderNetworkRequest' provider_account: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefProviderAccountRequest' nullable: true nullable: true type: oneOf: - type: integer - $ref: '#/components/schemas/BriefVirtualCircuitTypeRequest' status: enum: - planned - provisioning - active - offline - deprovisioning - decommissioned type: string description: '* `planned` - Planned * `provisioning` - Provisioning * `active` - Active * `offline` - Offline * `deprovisioning` - Deprovisioning * `decommissioned` - Decommissioned' x-spec-enum-id: 0a239d878b6666a4 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - cid - provider_network - type BriefCircuitTypeRequest: 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 BriefVirtualCircuitRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: cid: type: string minLength: 1 title: Circuit ID description: Unique circuit ID maxLength: 100 provider_network: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderNetworkRequest' description: type: string maxLength: 200 required: - cid - provider_network PatchedProviderAccountRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: provider: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderRequest' name: type: string default: '' maxLength: 100 account: type: string minLength: 1 title: Account ID maxLength: 100 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedVirtualCircuitTypeList: 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/VirtualCircuitType' CircuitTerminationRequest: type: object description: Adds support for custom fields and tags. properties: circuit: oneOf: - type: integer - $ref: '#/components/schemas/BriefCircuitRequest' term_side: enum: - A - Z type: string description: '* `A` - A * `Z` - Z' x-spec-enum-id: 95b8fcc737f355d0 title: Termination side termination_type: type: string nullable: true termination_id: type: integer nullable: true port_speed: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Port speed (Kbps) description: Physical circuit speed upstream_speed: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Upstream speed (Kbps) description: Upstream speed, if different from port speed xconnect_id: type: string title: Cross-connect ID description: ID of the local cross-connect maxLength: 50 pp_info: type: string title: Patch panel/port(s) description: Patch panel ID and port number(s) maxLength: 100 description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - circuit - term_side 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 PaginatedProviderNetworkList: 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/ProviderNetwork' BriefCircuitGroup: 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 required: - display - id - name - url BriefOwnerRequest: type: object description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name BriefCircuitGroupRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 required: - name BriefCircuitGroupAssignmentSerializer_: type: object description: Base serializer for group assignments under CircuitSerializer. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true group: $ref: '#/components/schemas/BriefCircuitGroup' priority: type: object properties: value: enum: - primary - secondary - tertiary - inactive - '' type: string description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' x-spec-enum-id: 0548fc537440bf9d label: type: string enum: - Primary - Secondary - Tertiary - Inactive required: - display - group - id - url PaginatedVirtualCircuitTerminationList: 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/VirtualCircuitTermination' VirtualCircuitType: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true virtual_circuit_count: type: integer format: int64 readOnly: true required: - created - display - display_url - id - last_updated - name - slug - url - virtual_circuit_count BriefProviderRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 description: Full name of the provider maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug PatchedWritableVirtualCircuitTerminationRequest: type: object description: Adds support for custom fields and tags. properties: virtual_circuit: oneOf: - type: integer - $ref: '#/components/schemas/BriefVirtualCircuitRequest' role: enum: - peer - hub - spoke type: string description: '* `peer` - Peer * `hub` - Hub * `spoke` - Spoke' x-spec-enum-id: 0b3bfadcebd86b58 interface: oneOf: - type: integer - $ref: '#/components/schemas/BriefInterfaceRequest' description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} Circuit: 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 cid: type: string title: Circuit ID description: Unique circuit ID maxLength: 100 provider: $ref: '#/components/schemas/BriefProvider' provider_account: allOf: - $ref: '#/components/schemas/BriefProviderAccount' nullable: true type: $ref: '#/components/schemas/BriefCircuitType' status: type: object properties: value: enum: - planned - provisioning - active - offline - deprovisioning - decommissioned type: string description: '* `planned` - Planned * `provisioning` - Provisioning * `active` - Active * `offline` - Offline * `deprovisioning` - Deprovisioning * `decommissioned` - Decommissioned' x-spec-enum-id: 0a239d878b6666a4 label: type: string enum: - Planned - Provisioning - Active - Offline - Deprovisioning - Decommissioned tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true install_date: type: string format: date nullable: true title: Installed termination_date: type: string format: date nullable: true title: Terminates commit_rate: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Commit rate (Kbps) description: Committed rate description: type: string maxLength: 200 distance: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true distance_unit: type: object properties: value: enum: - km - m - mi - ft - '' - null type: string description: '* `km` - Kilometers * `m` - Meters * `mi` - Miles * `ft` - Feet' x-spec-enum-id: b1169a409430c02e label: type: string enum: - Kilometers - Meters - Miles - Feet nullable: true termination_a: allOf: - $ref: '#/components/schemas/CircuitCircuitTermination' readOnly: true nullable: true termination_z: allOf: - $ref: '#/components/schemas/CircuitCircuitTermination' readOnly: true nullable: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true assignments: type: array items: $ref: '#/components/schemas/BriefCircuitGroupAssignmentSerializer_' required: - cid - created - display - display_url - id - last_updated - provider - termination_a - termination_z - type - url CircuitRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: cid: type: string minLength: 1 title: Circuit ID description: Unique circuit ID maxLength: 100 provider: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderRequest' provider_account: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefProviderAccountRequest' nullable: true nullable: true type: oneOf: - type: integer - $ref: '#/components/schemas/BriefCircuitTypeRequest' status: enum: - planned - provisioning - active - offline - deprovisioning - decommissioned type: string description: '* `planned` - Planned * `provisioning` - Provisioning * `active` - Active * `offline` - Offline * `deprovisioning` - Deprovisioning * `decommissioned` - Decommissioned' x-spec-enum-id: 0a239d878b6666a4 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true install_date: type: string format: date nullable: true title: Installed termination_date: type: string format: date nullable: true title: Terminates commit_rate: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Commit rate (Kbps) description: Committed rate description: type: string maxLength: 200 distance: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true distance_unit: enum: - km - m - mi - ft - '' - null type: string description: '* `km` - Kilometers * `m` - Meters * `mi` - Miles * `ft` - Feet' x-spec-enum-id: b1169a409430c02e nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} assignments: type: array items: $ref: '#/components/schemas/BriefCircuitGroupAssignmentSerializer_Request' required: - cid - provider - type BriefDeviceRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string nullable: true maxLength: 64 description: type: string maxLength: 200 PaginatedVirtualCircuitList: 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/VirtualCircuit' ProviderAccountRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: provider: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderRequest' name: type: string default: '' maxLength: 100 account: type: string minLength: 1 title: Account ID maxLength: 100 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - account - provider PatchedWritableCircuitRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: cid: type: string minLength: 1 title: Circuit ID description: Unique circuit ID maxLength: 100 provider: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderRequest' provider_account: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefProviderAccountRequest' nullable: true nullable: true type: oneOf: - type: integer - $ref: '#/components/schemas/BriefCircuitTypeRequest' status: enum: - planned - provisioning - active - offline - deprovisioning - decommissioned type: string description: '* `planned` - Planned * `provisioning` - Provisioning * `active` - Active * `offline` - Offline * `deprovisioning` - Deprovisioning * `decommissioned` - Decommissioned' x-spec-enum-id: 0a239d878b6666a4 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true install_date: type: string format: date nullable: true title: Installed termination_date: type: string format: date nullable: true title: Terminates commit_rate: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Commit rate (Kbps) description: Committed rate description: type: string maxLength: 200 distance: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true distance_unit: enum: - km - m - mi - ft - '' - null type: string description: '* `km` - Kilometers * `m` - Meters * `mi` - Miles * `ft` - Feet' x-spec-enum-id: b1169a409430c02e nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} assignments: type: array items: $ref: '#/components/schemas/BriefCircuitGroupAssignmentSerializer_Request' CircuitGroupAssignmentRequest: type: object description: Base serializer for group assignments under CircuitSerializer. properties: group: oneOf: - type: integer - $ref: '#/components/schemas/BriefCircuitGroupRequest' member_type: type: string member_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 priority: enum: - primary - secondary - tertiary - inactive - '' type: string description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' x-spec-enum-id: 0548fc537440bf9d tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' required: - group - member_id - member_type CircuitType: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true circuit_count: type: integer format: int64 readOnly: true required: - circuit_count - created - display - display_url - id - last_updated - name - slug - url PaginatedCircuitTypeList: 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/CircuitType' PaginatedCircuitGroupAssignmentList: 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/CircuitGroupAssignment' BriefVirtualCircuitType: 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 virtual_circuit_count: type: integer format: int64 readOnly: true required: - display - id - name - slug - url - virtual_circuit_count PatchedCircuitGroupRequest: 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 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PatchedCircuitTerminationRequest: type: object description: Adds support for custom fields and tags. properties: circuit: oneOf: - type: integer - $ref: '#/components/schemas/BriefCircuitRequest' term_side: enum: - A - Z type: string description: '* `A` - A * `Z` - Z' x-spec-enum-id: 95b8fcc737f355d0 title: Termination side termination_type: type: string nullable: true termination_id: type: integer nullable: true port_speed: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Port speed (Kbps) description: Physical circuit speed upstream_speed: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Upstream speed (Kbps) description: Upstream speed, if different from port speed xconnect_id: type: string title: Cross-connect ID description: ID of the local cross-connect maxLength: 50 pp_info: type: string title: Patch panel/port(s) description: Patch panel ID and port number(s) maxLength: 100 description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefRIR: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 aggregate_count: type: integer format: int64 readOnly: true required: - aggregate_count - display - id - name - slug - url CircuitTermination: type: object description: Adds support for custom fields and tags. 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 circuit: $ref: '#/components/schemas/BriefCircuit' term_side: enum: - A - Z type: string description: '* `A` - A * `Z` - Z' x-spec-enum-id: 95b8fcc737f355d0 title: Termination side termination_type: type: string nullable: true termination_id: type: integer nullable: true termination: readOnly: true nullable: true port_speed: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Port speed (Kbps) description: Physical circuit speed upstream_speed: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Upstream speed (Kbps) description: Upstream speed, if different from port speed xconnect_id: type: string title: Cross-connect ID description: ID of the local cross-connect maxLength: 50 pp_info: type: string title: Patch panel/port(s) description: Patch panel ID and port number(s) maxLength: 100 description: type: string maxLength: 200 mark_connected: type: boolean description: Treat as if a cable is connected cable: allOf: - $ref: '#/components/schemas/BriefCable' readOnly: true nullable: true cable_end: type: string readOnly: true link_peers: type: array items: {} readOnly: true link_peers_type: type: string description: Return the type of the peer link terminations, or None. readOnly: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - cable - cable_end - circuit - created - display - display_url - id - last_updated - link_peers - link_peers_type - term_side - termination - url BriefInterfaceRequest: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: device: oneOf: - type: integer - $ref: '#/components/schemas/BriefDeviceRequest' name: type: string minLength: 1 maxLength: 64 description: type: string maxLength: 200 required: - device - name 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 ProviderRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 description: Full name of the provider maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ accounts: type: array items: type: integer description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string asns: type: array items: type: integer tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug PatchedWritableCircuitGroupAssignmentRequest: type: object description: Base serializer for group assignments under CircuitSerializer. properties: group: oneOf: - type: integer - $ref: '#/components/schemas/BriefCircuitGroupRequest' member_type: type: string member_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 priority: enum: - primary - secondary - tertiary - inactive - '' - null type: string description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' x-spec-enum-id: 0548fc537440bf9d nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' PaginatedCircuitGroupList: 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/CircuitGroup' CircuitGroup: 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 tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true circuit_count: type: integer format: int64 readOnly: true required: - circuit_count - created - display - display_url - id - last_updated - name - slug - url 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 ASNSite: type: object description: 'This serializer is meant for inclusion in ASNSerializer and is only used to avoid a circular import of SiteSerializer.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string description: Full name of the site maxLength: 100 description: type: string maxLength: 200 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ required: - display - id - name - slug - url PatchedCircuitTypeRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} CircuitGroupRequest: 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 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug WritableCircuitRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: cid: type: string minLength: 1 title: Circuit ID description: Unique circuit ID maxLength: 100 provider: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderRequest' provider_account: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefProviderAccountRequest' nullable: true nullable: true type: oneOf: - type: integer - $ref: '#/components/schemas/BriefCircuitTypeRequest' status: enum: - planned - provisioning - active - offline - deprovisioning - decommissioned type: string description: '* `planned` - Planned * `provisioning` - Provisioning * `active` - Active * `offline` - Offline * `deprovisioning` - Deprovisioning * `decommissioned` - Decommissioned' x-spec-enum-id: 0a239d878b6666a4 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true install_date: type: string format: date nullable: true title: Installed termination_date: type: string format: date nullable: true title: Terminates commit_rate: type: integer maximum: 2147483647 minimum: 0 nullable: true title: Commit rate (Kbps) description: Committed rate description: type: string maxLength: 200 distance: type: number format: double maximum: 1000000 minimum: -1000000 exclusiveMaximum: true exclusiveMinimum: true nullable: true distance_unit: enum: - km - m - mi - ft - '' - null type: string description: '* `km` - Kilometers * `m` - Meters * `mi` - Miles * `ft` - Feet' x-spec-enum-id: b1169a409430c02e nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} assignments: type: array items: $ref: '#/components/schemas/BriefCircuitGroupAssignmentSerializer_Request' required: - cid - provider - type 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 BriefCircuitType: 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 circuit_count: type: integer format: int64 readOnly: true required: - circuit_count - display - id - name - slug - url 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 BriefCircuitRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: cid: type: string minLength: 1 title: Circuit ID description: Unique circuit ID maxLength: 100 provider: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderRequest' description: type: string maxLength: 200 required: - cid - provider CircuitGroupAssignment: type: object description: Base serializer for group assignments under CircuitSerializer. 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 group: $ref: '#/components/schemas/BriefCircuitGroup' member_type: type: string member_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 member: readOnly: true nullable: true priority: type: object properties: value: enum: - primary - secondary - tertiary - inactive - '' type: string description: '* `primary` - Primary * `secondary` - Secondary * `tertiary` - Tertiary * `inactive` - Inactive' x-spec-enum-id: 0548fc537440bf9d label: type: string enum: - Primary - Secondary - Tertiary - Inactive tags: type: array items: $ref: '#/components/schemas/NestedTag' 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 - group - id - last_updated - member - member_id - member_type - url WritableVirtualCircuitRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: cid: type: string minLength: 1 title: Circuit ID description: Unique circuit ID maxLength: 100 provider_network: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderNetworkRequest' provider_account: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefProviderAccountRequest' nullable: true nullable: true type: oneOf: - type: integer - $ref: '#/components/schemas/BriefVirtualCircuitTypeRequest' status: enum: - planned - provisioning - active - offline - deprovisioning - decommissioned type: string description: '* `planned` - Planned * `provisioning` - Provisioning * `active` - Active * `offline` - Offline * `deprovisioning` - Deprovisioning * `decommissioned` - Decommissioned' x-spec-enum-id: 0a239d878b6666a4 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - cid - provider_network - type VirtualCircuitTerminationRequest: type: object description: Adds support for custom fields and tags. properties: virtual_circuit: oneOf: - type: integer - $ref: '#/components/schemas/BriefVirtualCircuitRequest' role: enum: - peer - hub - spoke type: string description: '* `peer` - Peer * `hub` - Hub * `spoke` - Spoke' x-spec-enum-id: 0b3bfadcebd86b58 interface: oneOf: - type: integer - $ref: '#/components/schemas/BriefInterfaceRequest' description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - interface - virtual_circuit CircuitTypeRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug BriefInterface: type: object description: Adds an `owner` field for models which have a ForeignKey to users.Owner. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true device: $ref: '#/components/schemas/BriefDevice' name: type: string maxLength: 64 description: type: string maxLength: 200 cable: allOf: - $ref: '#/components/schemas/BriefCable' readOnly: true nullable: true _occupied: type: boolean readOnly: true title: ' occupied' required: - _occupied - cable - device - display - id - name - url ASN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true asn: type: integer maximum: 4294967295 minimum: 1 format: int64 description: 16- or 32-bit autonomous system number rir: allOf: - $ref: '#/components/schemas/BriefRIR' nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true site_count: type: integer format: int64 readOnly: true provider_count: type: integer format: int64 readOnly: true sites: type: array items: $ref: '#/components/schemas/ASNSite' required: - asn - created - display - display_url - id - last_updated - provider_count - site_count - url PatchedWritableVirtualCircuitRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: cid: type: string minLength: 1 title: Circuit ID description: Unique circuit ID maxLength: 100 provider_network: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderNetworkRequest' provider_account: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefProviderAccountRequest' nullable: true nullable: true type: oneOf: - type: integer - $ref: '#/components/schemas/BriefVirtualCircuitTypeRequest' status: enum: - planned - provisioning - active - offline - deprovisioning - decommissioned type: string description: '* `planned` - Planned * `provisioning` - Provisioning * `active` - Active * `offline` - Offline * `deprovisioning` - Deprovisioning * `decommissioned` - Decommissioned' x-spec-enum-id: 0a239d878b6666a4 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefVirtualCircuitTypeRequest: 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 VirtualCircuitTypeRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug NestedProviderAccount: 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 account: type: string title: Account ID maxLength: 100 required: - account - display - display_url - id - url BriefProvider: 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 provider maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 circuit_count: type: integer format: int64 readOnly: true required: - circuit_count - display - id - name - slug - url VirtualCircuit: 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 cid: type: string title: Circuit ID description: Unique circuit ID maxLength: 100 provider_network: $ref: '#/components/schemas/BriefProviderNetwork' provider_account: allOf: - $ref: '#/components/schemas/BriefProviderAccount' nullable: true type: $ref: '#/components/schemas/BriefVirtualCircuitType' status: type: object properties: value: enum: - planned - provisioning - active - offline - deprovisioning - decommissioned type: string description: '* `planned` - Planned * `provisioning` - Provisioning * `active` - Active * `offline` - Offline * `deprovisioning` - Deprovisioning * `decommissioned` - Decommissioned' x-spec-enum-id: 0a239d878b6666a4 label: type: string enum: - Planned - Provisioning - Active - Offline - Deprovisioning - Decommissioned tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - cid - created - display - display_url - id - last_updated - provider_network - type - url PatchedProviderNetworkRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: provider: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderRequest' name: type: string minLength: 1 maxLength: 100 service_id: type: string maxLength: 100 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} ProviderNetworkRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: provider: oneOf: - type: integer - $ref: '#/components/schemas/BriefProviderRequest' name: type: string minLength: 1 maxLength: 100 service_id: type: string maxLength: 100 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - provider BriefCable: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true label: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - url securitySchemes: cookieAuth: type: apiKey in: cookie name: sessionid tokenAuth: type: apiKey in: header name: Authorization description: '`Token ` (v1) or `Bearer .` (v2)'